@shopify/flash-list 1.2.2 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/FlashList.d.ts +1 -1
  3. package/dist/FlashList.d.ts.map +1 -1
  4. package/dist/FlashList.js +8 -4
  5. package/dist/FlashList.js.map +1 -1
  6. package/dist/MasonryFlashList.d.ts +39 -0
  7. package/dist/MasonryFlashList.d.ts.map +1 -0
  8. package/dist/MasonryFlashList.js +241 -0
  9. package/dist/MasonryFlashList.js.map +1 -0
  10. package/dist/__tests__/MasonryFlashList.test.d.ts +2 -0
  11. package/dist/__tests__/MasonryFlashList.test.d.ts.map +1 -0
  12. package/dist/__tests__/MasonryFlashList.test.js +205 -0
  13. package/dist/__tests__/MasonryFlashList.test.js.map +1 -0
  14. package/dist/__tests__/helpers/mountMasonryFlashList.d.ts +18 -0
  15. package/dist/__tests__/helpers/mountMasonryFlashList.d.ts.map +1 -0
  16. package/dist/__tests__/helpers/mountMasonryFlashList.js +44 -0
  17. package/dist/__tests__/helpers/mountMasonryFlashList.js.map +1 -0
  18. package/dist/errors/ExceptionList.d.ts +4 -0
  19. package/dist/errors/ExceptionList.d.ts.map +1 -1
  20. package/dist/errors/ExceptionList.js +4 -0
  21. package/dist/errors/ExceptionList.js.map +1 -1
  22. package/dist/index.d.ts +1 -0
  23. package/dist/index.d.ts.map +1 -1
  24. package/dist/index.js +3 -1
  25. package/dist/index.js.map +1 -1
  26. package/dist/tsconfig.tsbuildinfo +1 -1
  27. package/dist/viewability/ViewabilityManager.d.ts.map +1 -1
  28. package/dist/viewability/ViewabilityManager.js +3 -3
  29. package/dist/viewability/ViewabilityManager.js.map +1 -1
  30. package/package.json +1 -1
  31. package/src/FlashList.tsx +10 -5
  32. package/src/MasonryFlashList.tsx +439 -0
  33. package/src/__tests__/MasonryFlashList.test.ts +235 -0
  34. package/src/__tests__/helpers/mountMasonryFlashList.tsx +65 -0
  35. package/src/errors/ExceptionList.ts +5 -0
  36. package/src/index.ts +7 -0
  37. package/src/viewability/ViewabilityManager.ts +2 -1
@@ -30,12 +30,12 @@ var ViewabilityManager = /** @class */ (function () {
30
30
  _this.updateViewableItems();
31
31
  };
32
32
  this.updateViewableItems = function (newViewableIndices) {
33
- var _a, _b, _c;
34
- var listSize = (_a = _this.flashListRef.recyclerlistview_unsafe) === null || _a === void 0 ? void 0 : _a.getRenderedSize();
33
+ var _a, _b, _c, _d;
34
+ var listSize = (_b = (_a = _this.flashListRef.recyclerlistview_unsafe) === null || _a === void 0 ? void 0 : _a.getRenderedSize()) !== null && _b !== void 0 ? _b : _this.flashListRef.props.estimatedListSize;
35
35
  if (listSize === undefined || !_this.shouldListenToVisibleIndices) {
36
36
  return;
37
37
  }
38
- var scrollOffset = ((_c = (_b = _this.flashListRef.recyclerlistview_unsafe) === null || _b === void 0 ? void 0 : _b.getCurrentScrollOffset()) !== null && _c !== void 0 ? _c : 0) - _this.flashListRef.firstItemOffset;
38
+ var scrollOffset = ((_d = (_c = _this.flashListRef.recyclerlistview_unsafe) === null || _c === void 0 ? void 0 : _c.getCurrentScrollOffset()) !== null && _d !== void 0 ? _d : 0) - _this.flashListRef.firstItemOffset;
39
39
  _this.viewabilityHelpers.forEach(function (viewabilityHelper) {
40
40
  var _a;
41
41
  viewabilityHelper.updateViewableItems((_a = _this.flashListRef.props.horizontal) !== null && _a !== void 0 ? _a : false, scrollOffset, listSize, function (index) { var _a; return (_a = _this.flashListRef.recyclerlistview_unsafe) === null || _a === void 0 ? void 0 : _a.getLayout(index); }, newViewableIndices);
@@ -1 +1 @@
1
- {"version":3,"file":"ViewabilityManager.js","sourceRoot":"","sources":["../../src/viewability/ViewabilityManager.ts"],"names":[],"mappings":";;;AAIA,kFAAoD;AAGpD;;GAEG;AACH;IAKE,4BAAY,YAA0B;QAAtC,iBAuBC;;QA1BO,uBAAkB,GAAwB,EAAE,CAAC;QAC7C,kBAAa,GAAG,KAAK,CAAC;QAkCvB,YAAO,GAAG;YACf,KAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAC,iBAAiB;gBAChD,OAAA,iBAAiB,CAAC,OAAO,EAAE;YAA3B,CAA2B,CAC5B,CAAC;QACJ,CAAC,CAAC;QAEK,4BAAuB,GAAG,UAAC,GAAa;YAC7C,KAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC,CAAC;QAEK,sBAAiB,GAAG;YACzB,IAAI,KAAI,CAAC,aAAa,EAAE;gBACtB,OAAO;aACR;YACD,KAAI,CAAC,aAAa,GAAG,IAAI,CAAC;YAC1B,KAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAC,iBAAiB;gBAChD,iBAAiB,CAAC,aAAa,GAAG,IAAI,CAAC;YACzC,CAAC,CAAC,CAAC;YACH,KAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC,CAAC;QAEK,wBAAmB,GAAG,UAAC,kBAA6B;;YACzD,IAAM,QAAQ,GACZ,MAAA,KAAI,CAAC,YAAY,CAAC,uBAAuB,0CAAE,eAAe,EAAE,CAAC;YAC/D,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,KAAI,CAAC,4BAA4B,EAAE;gBAChE,OAAO;aACR;YACD,IAAM,YAAY,GAChB,CAAC,MAAA,MAAA,KAAI,CAAC,YAAY,CAAC,uBAAuB,0CAAE,sBAAsB,EAAE,mCAClE,CAAC,CAAC,GAAG,KAAI,CAAC,YAAY,CAAC,eAAe,CAAC;YAC3C,KAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAC,iBAAiB;;gBAChD,iBAAiB,CAAC,mBAAmB,CACnC,MAAA,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,mCAAI,KAAK,EAC3C,YAAY,EACZ,QAAQ,EACR,UAAC,KAAa,YACZ,OAAA,MAAA,KAAI,CAAC,YAAY,CAAC,uBAAuB,0CAAE,SAAS,CAAC,KAAK,CAAC,CAAA,EAAA,EAC7D,kBAAkB,CACnB,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF;;;WAGG;QACK,4BAAuB,GAAG,UAChC,iBAAuD,EACvD,sBAGa;YAEb,IAAM,YAAY,GAAsD,UACtE,KAAa,EACb,UAAmB;;gBAEnB,IAAM,IAAI,GAAG,MAAA,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,0CAAG,KAAK,CAAC,CAAC;gBACnD,IAAM,GAAG,GACP,IAAI,KAAK,SAAS,IAAI,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,KAAK,SAAS;oBACtE,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE;oBAClB,CAAC,CAAC,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACxD,OAAO;oBACL,KAAK,OAAA;oBACL,UAAU,YAAA;oBACV,IAAI,MAAA;oBACJ,GAAG,KAAA;oBACH,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;iBACtB,CAAC;YACJ,CAAC,CAAC;YACF,OAAO,IAAI,2BAAiB,CAC1B,iBAAiB,EACjB,UAAC,OAAO,EAAE,mBAAmB,EAAE,sBAAsB;gBACnD,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAG;oBACvB,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,EAAzB,CAAyB,CAAC;oBAChE,OAAO,iEACF,mBAAmB,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,EAAzB,CAAyB,CAAC,0BAC7D,sBAAsB,CAAC,GAAG,CAAC,UAAC,KAAK;wBAClC,OAAA,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC;oBAA1B,CAA0B,CAC3B,SACF;iBACF,CAAC,CAAC;YACL,CAAC,CACF,CAAC;QACJ,CAAC,CAAC;QAnHA,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IACE,YAAY,CAAC,KAAK,CAAC,sBAAsB,KAAK,IAAI;YAClD,YAAY,CAAC,KAAK,CAAC,sBAAsB,KAAK,SAAS,EACvD;YACA,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAC1B,IAAI,CAAC,uBAAuB,CAC1B,YAAY,CAAC,KAAK,CAAC,iBAAiB,EACpC,YAAY,CAAC,KAAK,CAAC,sBAAsB,CAC1C,CACF,CAAC;SACH;QACD,CAAC,MAAA,YAAY,CAAC,KAAK,CAAC,8BAA8B,mCAAI,EAAE,CAAC,CAAC,OAAO,CAC/D,UAAC,IAAI;YACH,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAC1B,KAAI,CAAC,uBAAuB,CAC1B,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,sBAAsB,CAC5B,CACF,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAKD,sBAAW,4DAA4B;QAHvC;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC;QAC5C,CAAC;;;OAAA;IAuFH,yBAAC;AAAD,CAAC,AA1HD,IA0HC"}
1
+ {"version":3,"file":"ViewabilityManager.js","sourceRoot":"","sources":["../../src/viewability/ViewabilityManager.ts"],"names":[],"mappings":";;;AAIA,kFAAoD;AAGpD;;GAEG;AACH;IAKE,4BAAY,YAA0B;QAAtC,iBAuBC;;QA1BO,uBAAkB,GAAwB,EAAE,CAAC;QAC7C,kBAAa,GAAG,KAAK,CAAC;QAkCvB,YAAO,GAAG;YACf,KAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAC,iBAAiB;gBAChD,OAAA,iBAAiB,CAAC,OAAO,EAAE;YAA3B,CAA2B,CAC5B,CAAC;QACJ,CAAC,CAAC;QAEK,4BAAuB,GAAG,UAAC,GAAa;YAC7C,KAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC,CAAC;QAEK,sBAAiB,GAAG;YACzB,IAAI,KAAI,CAAC,aAAa,EAAE;gBACtB,OAAO;aACR;YACD,KAAI,CAAC,aAAa,GAAG,IAAI,CAAC;YAC1B,KAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAC,iBAAiB;gBAChD,iBAAiB,CAAC,aAAa,GAAG,IAAI,CAAC;YACzC,CAAC,CAAC,CAAC;YACH,KAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC,CAAC;QAEK,wBAAmB,GAAG,UAAC,kBAA6B;;YACzD,IAAM,QAAQ,GACZ,MAAA,MAAA,KAAI,CAAC,YAAY,CAAC,uBAAuB,0CAAE,eAAe,EAAE,mCAC5D,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC;YAC5C,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,KAAI,CAAC,4BAA4B,EAAE;gBAChE,OAAO;aACR;YACD,IAAM,YAAY,GAChB,CAAC,MAAA,MAAA,KAAI,CAAC,YAAY,CAAC,uBAAuB,0CAAE,sBAAsB,EAAE,mCAClE,CAAC,CAAC,GAAG,KAAI,CAAC,YAAY,CAAC,eAAe,CAAC;YAC3C,KAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAC,iBAAiB;;gBAChD,iBAAiB,CAAC,mBAAmB,CACnC,MAAA,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,mCAAI,KAAK,EAC3C,YAAY,EACZ,QAAQ,EACR,UAAC,KAAa,YACZ,OAAA,MAAA,KAAI,CAAC,YAAY,CAAC,uBAAuB,0CAAE,SAAS,CAAC,KAAK,CAAC,CAAA,EAAA,EAC7D,kBAAkB,CACnB,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF;;;WAGG;QACK,4BAAuB,GAAG,UAChC,iBAAuD,EACvD,sBAGa;YAEb,IAAM,YAAY,GAAsD,UACtE,KAAa,EACb,UAAmB;;gBAEnB,IAAM,IAAI,GAAG,MAAA,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,0CAAG,KAAK,CAAC,CAAC;gBACnD,IAAM,GAAG,GACP,IAAI,KAAK,SAAS,IAAI,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,KAAK,SAAS;oBACtE,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE;oBAClB,CAAC,CAAC,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACxD,OAAO;oBACL,KAAK,OAAA;oBACL,UAAU,YAAA;oBACV,IAAI,MAAA;oBACJ,GAAG,KAAA;oBACH,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;iBACtB,CAAC;YACJ,CAAC,CAAC;YACF,OAAO,IAAI,2BAAiB,CAC1B,iBAAiB,EACjB,UAAC,OAAO,EAAE,mBAAmB,EAAE,sBAAsB;gBACnD,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAG;oBACvB,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,EAAzB,CAAyB,CAAC;oBAChE,OAAO,iEACF,mBAAmB,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,EAAzB,CAAyB,CAAC,0BAC7D,sBAAsB,CAAC,GAAG,CAAC,UAAC,KAAK;wBAClC,OAAA,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC;oBAA1B,CAA0B,CAC3B,SACF;iBACF,CAAC,CAAC;YACL,CAAC,CACF,CAAC;QACJ,CAAC,CAAC;QApHA,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IACE,YAAY,CAAC,KAAK,CAAC,sBAAsB,KAAK,IAAI;YAClD,YAAY,CAAC,KAAK,CAAC,sBAAsB,KAAK,SAAS,EACvD;YACA,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAC1B,IAAI,CAAC,uBAAuB,CAC1B,YAAY,CAAC,KAAK,CAAC,iBAAiB,EACpC,YAAY,CAAC,KAAK,CAAC,sBAAsB,CAC1C,CACF,CAAC;SACH;QACD,CAAC,MAAA,YAAY,CAAC,KAAK,CAAC,8BAA8B,mCAAI,EAAE,CAAC,CAAC,OAAO,CAC/D,UAAC,IAAI;YACH,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAC1B,KAAI,CAAC,uBAAuB,CAC1B,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,sBAAsB,CAC5B,CACF,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAKD,sBAAW,4DAA4B;QAHvC;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC;QAC5C,CAAC;;;OAAA;IAwFH,yBAAC;AAAD,CAAC,AA3HD,IA2HC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shopify/flash-list",
3
- "version": "1.2.2",
3
+ "version": "1.3.0",
4
4
  "keywords": [
5
5
  "react-native",
6
6
  "recyclerview",
package/src/FlashList.tsx CHANGED
@@ -141,7 +141,7 @@ class FlashList<T> extends React.PureComponent<
141
141
 
142
142
  // Some of the state variables need to update when props change
143
143
  static getDerivedStateFromProps<T>(
144
- nextProps: FlashListProps<T>,
144
+ nextProps: Readonly<FlashListProps<T>>,
145
145
  prevState: FlashListState<T>
146
146
  ): FlashListState<T> {
147
147
  const newState = { ...prevState };
@@ -427,7 +427,7 @@ class FlashList<T> extends React.PureComponent<
427
427
  return (
428
428
  <>
429
429
  <PureComponentWrapper
430
- enabled={children.length > 0 || this.isEmptyList}
430
+ enabled={this.isListLoaded || children.length > 0 || this.isEmptyList}
431
431
  contentStyle={this.props.contentContainerStyle}
432
432
  horizontal={this.props.horizontal}
433
433
  header={this.props.ListHeaderComponent}
@@ -448,7 +448,7 @@ class FlashList<T> extends React.PureComponent<
448
448
  ? this.getValidComponent(this.props.ListEmptyComponent)
449
449
  : null}
450
450
  <PureComponentWrapper
451
- enabled={children.length > 0 || this.isEmptyList}
451
+ enabled={this.isListLoaded || children.length > 0 || this.isEmptyList}
452
452
  contentStyle={this.props.contentContainerStyle}
453
453
  horizontal={this.props.horizontal}
454
454
  header={this.props.ListFooterComponent}
@@ -489,10 +489,15 @@ class FlashList<T> extends React.PureComponent<
489
489
  };
490
490
 
491
491
  private updateDistanceFromWindow = (event: LayoutChangeEvent) => {
492
- this.distanceFromWindow = this.props.horizontal
492
+ const newDistanceFromWindow = this.props.horizontal
493
493
  ? event.nativeEvent.layout.x
494
494
  : event.nativeEvent.layout.y;
495
- this.windowCorrectionConfig.value.windowShift = -this.distanceFromWindow;
495
+
496
+ if (this.distanceFromWindow !== newDistanceFromWindow) {
497
+ this.distanceFromWindow = newDistanceFromWindow;
498
+ this.windowCorrectionConfig.value.windowShift = -this.distanceFromWindow;
499
+ this.viewabilityManager.updateViewableItems();
500
+ }
496
501
  };
497
502
 
498
503
  private getTransform() {
@@ -0,0 +1,439 @@
1
+ import React, { useCallback, useRef, useEffect, useMemo } from "react";
2
+ import {
3
+ View,
4
+ Dimensions,
5
+ ScrollViewProps,
6
+ LayoutChangeEvent,
7
+ NativeScrollEvent,
8
+ NativeSyntheticEvent,
9
+ } from "react-native";
10
+
11
+ import CustomError from "./errors/CustomError";
12
+ import ExceptionList from "./errors/ExceptionList";
13
+ import FlashList from "./FlashList";
14
+ import { FlashListProps } from "./FlashListProps";
15
+ import ViewToken from "./viewability/ViewToken";
16
+
17
+ export interface MasonryFlashListProps<T>
18
+ extends Omit<
19
+ FlashListProps<T>,
20
+ | "horizontal"
21
+ | "initialScrollIndex"
22
+ | "inverted"
23
+ | "onBlankArea"
24
+ | "viewabilityConfigCallbackPairs"
25
+ > {
26
+ /**
27
+ * Allows you to change the column widths of the list. This is helpful if you want some columns to be wider than the others.
28
+ * e.g, if `numColumns` is `3`, you can return `2` for `index 1` and `1` for the rest to achieve a `1:2:1` split by width.
29
+ */
30
+ getColumnFlex?: (
31
+ items: MasonryListItem<T>[],
32
+ columnIndex: number,
33
+ maxColumns: number,
34
+ extraData?: any
35
+ ) => number;
36
+
37
+ /**
38
+ * If enabled, MasonryFlashList will try to reduce difference in column height by modifying item order.
39
+ * `overrideItemLayout` is required to make this work.
40
+ */
41
+ optimizeItemArrangement?: boolean;
42
+ }
43
+
44
+ type OnScrollCallback = ScrollViewProps["onScroll"];
45
+ const defaultEstimatedItemSize = 100;
46
+
47
+ export interface MasonryFlashListScrollEvent extends NativeScrollEvent {
48
+ doNotPropagate?: boolean;
49
+ }
50
+
51
+ export interface MasonryListItem<T> {
52
+ originalIndex: number;
53
+ originalItem: T;
54
+ }
55
+
56
+ /**
57
+ * MasonryFlashListRef with support for scroll related methods
58
+ */
59
+ export interface MasonryFlashListRef<T> {
60
+ scrollToOffset: FlashList<T>["scrollToOffset"];
61
+ scrollToEnd: FlashList<T>["scrollToEnd"];
62
+ getScrollableNode: FlashList<T>["getScrollableNode"];
63
+ }
64
+
65
+ /**
66
+ * FlashList variant that enables rendering of masonry layouts.
67
+ * If you want `MasonryFlashList` to optimize item arrangement, enable `optimizeItemArrangement` and pass a valid `overrideItemLayout` function.
68
+ */
69
+ const MasonryFlashListComponent = React.forwardRef(
70
+ <T,>(
71
+ /**
72
+ * Forward Ref will force cast generic parament T to unknown. Export has a explicit cast to solve this.
73
+ */
74
+ props: MasonryFlashListProps<T>,
75
+ forwardRef: React.ForwardedRef<MasonryFlashListRef<T>>
76
+ ) => {
77
+ const columnCount = props.numColumns || 1;
78
+ const drawDistance = props.drawDistance;
79
+ const estimatedListSize = props.estimatedListSize ??
80
+ Dimensions.get("window") ?? { height: 500, width: 500 };
81
+
82
+ if (props.optimizeItemArrangement && !props.overrideItemLayout) {
83
+ throw new CustomError(
84
+ ExceptionList.overrideItemLayoutRequiredForMasonryOptimization
85
+ );
86
+ }
87
+ const dataSet = useDataSet(
88
+ columnCount,
89
+ Boolean(props.optimizeItemArrangement),
90
+ props.data,
91
+ props.overrideItemLayout,
92
+ props.extraData
93
+ );
94
+
95
+ const totalColumnFlex = useTotalColumnFlex(dataSet, props);
96
+
97
+ const onScrollRef = useRef<OnScrollCallback[]>([]);
98
+ const emptyScrollEvent = useRef(getEmptyScrollEvent())
99
+ .current as NativeSyntheticEvent<MasonryFlashListScrollEvent>;
100
+ const ScrollComponent = useRef(
101
+ getFlashListScrollView(onScrollRef, () => {
102
+ return (
103
+ getListRenderedSize(parentFlashList)?.height ||
104
+ estimatedListSize.height
105
+ );
106
+ })
107
+ ).current;
108
+
109
+ const onScrollProxy = useRef<OnScrollCallback>(
110
+ (scrollEvent: NativeSyntheticEvent<MasonryFlashListScrollEvent>) => {
111
+ emptyScrollEvent.nativeEvent.contentOffset.y =
112
+ scrollEvent.nativeEvent.contentOffset.y -
113
+ (parentFlashList.current?.firstItemOffset ?? 0);
114
+ onScrollRef.current?.forEach((onScrollCallback) => {
115
+ onScrollCallback?.(emptyScrollEvent);
116
+ });
117
+ if (!scrollEvent.nativeEvent.doNotPropagate) {
118
+ props.onScroll?.(scrollEvent);
119
+ }
120
+ }
121
+ ).current;
122
+
123
+ /**
124
+ * We're triggering an onScroll on internal lists so that they register the correct offset which is offset - header size.
125
+ * This will make sure viewability callbacks are triggered correctly.
126
+ * 32 ms is equal to two frames at 60 fps. Faster framerates will not cause any problems.
127
+ */
128
+ const onLoadForNestedLists = useRef((args: { elapsedTimeInMs: number }) => {
129
+ setTimeout(() => {
130
+ emptyScrollEvent.nativeEvent.doNotPropagate = true;
131
+ onScrollProxy?.(emptyScrollEvent);
132
+ emptyScrollEvent.nativeEvent.doNotPropagate = false;
133
+ }, 32);
134
+ props.onLoad?.(args);
135
+ }).current;
136
+
137
+ const [parentFlashList, getFlashList] =
138
+ useRefWithForwardRef<FlashList<MasonryListItem<T>[]>>(forwardRef);
139
+
140
+ const {
141
+ renderItem,
142
+ getItemType,
143
+ getColumnFlex,
144
+ overrideItemLayout,
145
+ viewabilityConfig,
146
+ keyExtractor,
147
+ onLoad,
148
+ onViewableItemsChanged,
149
+ data,
150
+ stickyHeaderIndices,
151
+ CellRendererComponent,
152
+ ItemSeparatorComponent,
153
+ ...remainingProps
154
+ } = props;
155
+
156
+ const firstColumnHeight =
157
+ (dataSet[0]?.length ?? 0) *
158
+ (props.estimatedItemSize ?? defaultEstimatedItemSize);
159
+
160
+ return (
161
+ <FlashList
162
+ ref={getFlashList}
163
+ {...remainingProps}
164
+ horizontal={false}
165
+ numColumns={columnCount}
166
+ data={dataSet}
167
+ onScroll={onScrollProxy}
168
+ estimatedItemSize={firstColumnHeight || estimatedListSize.height}
169
+ renderItem={(args) => {
170
+ return (
171
+ <FlashList
172
+ renderScrollComponent={ScrollComponent}
173
+ estimatedItemSize={props.estimatedItemSize}
174
+ data={args.item}
175
+ onLoad={args.index === 0 ? onLoadForNestedLists : undefined}
176
+ renderItem={(innerArgs) => {
177
+ return (
178
+ renderItem?.({
179
+ ...innerArgs,
180
+ item: innerArgs.item.originalItem,
181
+ index: innerArgs.item.originalIndex,
182
+ }) ?? null
183
+ );
184
+ }}
185
+ keyExtractor={
186
+ keyExtractor
187
+ ? (item, _) => {
188
+ return keyExtractor?.(
189
+ item.originalItem,
190
+ item.originalIndex
191
+ );
192
+ }
193
+ : undefined
194
+ }
195
+ getItemType={
196
+ getItemType
197
+ ? (item, _, extraData) => {
198
+ return getItemType?.(
199
+ item.originalItem,
200
+ item.originalIndex,
201
+ extraData
202
+ );
203
+ }
204
+ : undefined
205
+ }
206
+ drawDistance={drawDistance}
207
+ estimatedListSize={{
208
+ height: estimatedListSize.height,
209
+ width:
210
+ ((getListRenderedSize(parentFlashList)?.width ||
211
+ estimatedListSize.width) /
212
+ totalColumnFlex) *
213
+ (getColumnFlex?.(
214
+ args.item,
215
+ args.index,
216
+ columnCount,
217
+ props.extraData
218
+ ) ?? 1),
219
+ }}
220
+ extraData={props.extraData}
221
+ CellRendererComponent={CellRendererComponent}
222
+ ItemSeparatorComponent={ItemSeparatorComponent}
223
+ viewabilityConfig={viewabilityConfig}
224
+ onViewableItemsChanged={
225
+ onViewableItemsChanged
226
+ ? (info) => {
227
+ updateViewTokens(info.viewableItems);
228
+ updateViewTokens(info.changed);
229
+ onViewableItemsChanged?.(info);
230
+ }
231
+ : undefined
232
+ }
233
+ overrideItemLayout={
234
+ overrideItemLayout
235
+ ? (layout, item, _, __, extraData) => {
236
+ overrideItemLayout?.(
237
+ layout,
238
+ item.originalItem,
239
+ item.originalIndex,
240
+ columnCount,
241
+ extraData
242
+ );
243
+ layout.span = undefined;
244
+ }
245
+ : undefined
246
+ }
247
+ />
248
+ );
249
+ }}
250
+ overrideItemLayout={
251
+ getColumnFlex
252
+ ? (layout, item, index, maxColumns, extraData) => {
253
+ layout.span =
254
+ (columnCount *
255
+ getColumnFlex(item, index, maxColumns, extraData)) /
256
+ totalColumnFlex;
257
+ }
258
+ : undefined
259
+ }
260
+ />
261
+ );
262
+ }
263
+ );
264
+
265
+ /**
266
+ * Splits data for each column's FlashList
267
+ */
268
+ const useDataSet = <T,>(
269
+ columnCount: number,
270
+ optimizeItemArrangement: boolean,
271
+ sourceData?: FlashListProps<T>["data"],
272
+ overrideItemLayout?: MasonryFlashListProps<T>["overrideItemLayout"],
273
+ extraData?: MasonryFlashListProps<T>["extraData"]
274
+ ): MasonryListItem<T>[][] => {
275
+ return useMemo(() => {
276
+ if (!sourceData || sourceData.length === 0) {
277
+ return [];
278
+ }
279
+ const columnHeightTracker = new Array<number>(columnCount).fill(0);
280
+ const layoutObject: { size: number | undefined } = { size: undefined };
281
+ const dataSet = new Array<MasonryListItem<T>[]>(columnCount);
282
+ const dataSize = sourceData.length;
283
+
284
+ for (let i = 0; i < columnCount; i++) {
285
+ dataSet[i] = [];
286
+ }
287
+ for (let i = 0; i < dataSize; i++) {
288
+ let nextColumnIndex = i % columnCount;
289
+ if (optimizeItemArrangement) {
290
+ for (let j = 0; j < columnCount; j++) {
291
+ if (columnHeightTracker[j] < columnHeightTracker[nextColumnIndex]) {
292
+ nextColumnIndex = j;
293
+ }
294
+ }
295
+ // update height of column
296
+ layoutObject.size = undefined;
297
+ overrideItemLayout!(
298
+ layoutObject,
299
+ sourceData[i],
300
+ i,
301
+ columnCount,
302
+ extraData
303
+ );
304
+ columnHeightTracker[nextColumnIndex] +=
305
+ layoutObject.size ?? defaultEstimatedItemSize;
306
+ }
307
+ dataSet[nextColumnIndex].push({
308
+ originalItem: sourceData[i],
309
+ originalIndex: i,
310
+ });
311
+ }
312
+ return dataSet;
313
+ // eslint-disable-next-line react-hooks/exhaustive-deps
314
+ }, [sourceData, columnCount, optimizeItemArrangement, extraData]);
315
+ };
316
+
317
+ const useTotalColumnFlex = <T,>(
318
+ dataSet: MasonryListItem<T>[][],
319
+ props: MasonryFlashListProps<T>
320
+ ): number => {
321
+ return useMemo(() => {
322
+ const columnCount = props.numColumns || 1;
323
+ if (!props.getColumnFlex) {
324
+ return columnCount;
325
+ }
326
+ let totalFlexSum = 0;
327
+ const dataSize = dataSet.length;
328
+ for (let i = 0; i < dataSize; i++) {
329
+ totalFlexSum += props.getColumnFlex(
330
+ dataSet[i],
331
+ i,
332
+ columnCount,
333
+ props.extraData
334
+ );
335
+ }
336
+ return totalFlexSum;
337
+ // eslint-disable-next-line react-hooks/exhaustive-deps
338
+ }, [dataSet, props.getColumnFlex, props.extraData]);
339
+ };
340
+
341
+ /**
342
+ * Handle both function refs and refs with current property
343
+ */
344
+ const useRefWithForwardRef = <T,>(
345
+ forwardRef: any
346
+ ): [React.MutableRefObject<T | null>, (instance: T | null) => void] => {
347
+ const ref: React.MutableRefObject<T | null> = useRef(null);
348
+ return [
349
+ ref,
350
+ useCallback(
351
+ (instance: T | null) => {
352
+ ref.current = instance;
353
+ if (typeof forwardRef === "function") {
354
+ forwardRef(instance);
355
+ } else if (forwardRef) {
356
+ forwardRef.current = instance;
357
+ }
358
+ },
359
+ [forwardRef]
360
+ ),
361
+ ];
362
+ };
363
+
364
+ /**
365
+ * This ScrollView is actually just a view mimicking a scrollview. We block the onScroll event from being passed to the parent list directly.
366
+ * We manually drive onScroll from the parent and thus, achieve recycling.
367
+ */
368
+ const getFlashListScrollView = (
369
+ onScrollRef: React.RefObject<OnScrollCallback[]>,
370
+ getParentHeight: () => number
371
+ ) => {
372
+ const FlashListScrollView = React.forwardRef(
373
+ (props: ScrollViewProps, ref: React.ForwardedRef<View>) => {
374
+ const { onLayout, onScroll, ...rest } = props;
375
+ const onLayoutProxy = useCallback(
376
+ (layoutEvent: LayoutChangeEvent) => {
377
+ onLayout?.({
378
+ nativeEvent: {
379
+ layout: {
380
+ height: getParentHeight(),
381
+ width: layoutEvent.nativeEvent.layout.width,
382
+ },
383
+ },
384
+ } as LayoutChangeEvent);
385
+ },
386
+ [onLayout]
387
+ );
388
+ useEffect(() => {
389
+ if (onScroll) {
390
+ onScrollRef.current?.push(onScroll);
391
+ }
392
+ return () => {
393
+ if (!onScrollRef.current || !onScroll) {
394
+ return;
395
+ }
396
+ const indexToDelete = onScrollRef.current.indexOf(onScroll);
397
+ if (indexToDelete > -1) {
398
+ onScrollRef.current.splice(indexToDelete, 1);
399
+ }
400
+ };
401
+ }, [onScroll]);
402
+ return <View ref={ref} {...rest} onLayout={onLayoutProxy} />;
403
+ }
404
+ );
405
+ FlashListScrollView.displayName = "FlashListScrollView";
406
+ return FlashListScrollView;
407
+ };
408
+ const updateViewTokens = (tokens: ViewToken[]) => {
409
+ const length = tokens.length;
410
+ for (let i = 0; i < length; i++) {
411
+ const token = tokens[i];
412
+ if (token.index !== null && token.index !== undefined) {
413
+ token.index = token.item.originalIndex;
414
+ token.item = token.item.originalItem;
415
+ }
416
+ }
417
+ };
418
+
419
+ const getEmptyScrollEvent = () => {
420
+ return {
421
+ nativeEvent: { contentOffset: { y: 0, x: 0 } },
422
+ };
423
+ };
424
+ const getListRenderedSize = <T,>(
425
+ parentFlashList: React.MutableRefObject<FlashList<T[]> | null>
426
+ ) => {
427
+ return parentFlashList?.current?.recyclerlistview_unsafe?.getRenderedSize();
428
+ };
429
+ MasonryFlashListComponent.displayName = "MasonryFlashList";
430
+
431
+ /**
432
+ * FlashList variant that enables rendering of masonry layouts.
433
+ * If you want `MasonryFlashList` to optimize item arrangement, enable `optimizeItemArrangement` and pass a valid `overrideItemLayout` function.
434
+ */
435
+ export const MasonryFlashList = MasonryFlashListComponent as <T>(
436
+ props: MasonryFlashListProps<T> & {
437
+ ref?: React.RefObject<MasonryFlashListRef<T>>;
438
+ }
439
+ ) => React.ReactElement;