@shopify/flash-list 1.2.2 → 1.3.1

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 +12 -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 +51 -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 +226 -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 +459 -0
  33. package/src/__tests__/MasonryFlashList.test.ts +264 -0
  34. package/src/__tests__/helpers/mountMasonryFlashList.tsx +65 -0
  35. package/src/errors/ExceptionList.ts +5 -0
  36. package/src/index.ts +9 -0
  37. package/src/viewability/ViewabilityManager.ts +2 -1
@@ -1 +1 @@
1
- {"version":3,"file":"ViewabilityManager.d.ts","sourceRoot":"","sources":["../../src/viewability/ViewabilityManager.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,cAAc,CAAC;AAKrC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB,CAAC,CAAC;IACvC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,kBAAkB,CAA2B;IACrD,OAAO,CAAC,aAAa,CAAS;gBAElB,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAyBtC;;OAEG;IACH,IAAW,4BAA4B,YAEtC;IAEM,OAAO,aAIZ;IAEK,uBAAuB,QAAS,MAAM,EAAE,UAE7C;IAEK,iBAAiB,aAStB;IAEK,mBAAmB,wBAAyB,MAAM,EAAE,UAmBzD;IAEF;;;OAGG;IACH,OAAO,CAAC,uBAAuB,CAsC7B;CACH"}
1
+ {"version":3,"file":"ViewabilityManager.d.ts","sourceRoot":"","sources":["../../src/viewability/ViewabilityManager.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,cAAc,CAAC;AAKrC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB,CAAC,CAAC;IACvC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,kBAAkB,CAA2B;IACrD,OAAO,CAAC,aAAa,CAAS;gBAElB,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAyBtC;;OAEG;IACH,IAAW,4BAA4B,YAEtC;IAEM,OAAO,aAIZ;IAEK,uBAAuB,QAAS,MAAM,EAAE,UAE7C;IAEK,iBAAiB,aAStB;IAEK,mBAAmB,wBAAyB,MAAM,EAAE,UAoBzD;IAEF;;;OAGG;IACH,OAAO,CAAC,uBAAuB,CAsC7B;CACH"}
@@ -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.1",
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,459 @@
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, ListRenderItemInfo } from "./FlashListProps";
15
+ import ViewToken from "./viewability/ViewToken";
16
+
17
+ export interface MasonryListRenderItemInfo<TItem>
18
+ extends ListRenderItemInfo<TItem> {
19
+ columnSpan: number;
20
+ columnIndex: number;
21
+ }
22
+
23
+ export type MasonryListRenderItem<TItem> = (
24
+ info: MasonryListRenderItemInfo<TItem>
25
+ ) => React.ReactElement | null;
26
+
27
+ export interface MasonryFlashListProps<T>
28
+ extends Omit<
29
+ FlashListProps<T>,
30
+ | "horizontal"
31
+ | "initialScrollIndex"
32
+ | "inverted"
33
+ | "onBlankArea"
34
+ | "viewabilityConfigCallbackPairs"
35
+ > {
36
+ /**
37
+ * Allows you to change the column widths of the list. This is helpful if you want some columns to be wider than the others.
38
+ * 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.
39
+ */
40
+ getColumnFlex?: (
41
+ items: MasonryListItem<T>[],
42
+ columnIndex: number,
43
+ maxColumns: number,
44
+ extraData?: any
45
+ ) => number;
46
+
47
+ /**
48
+ * If enabled, MasonryFlashList will try to reduce difference in column height by modifying item order.
49
+ * `overrideItemLayout` is required to make this work.
50
+ */
51
+ optimizeItemArrangement?: boolean;
52
+
53
+ /**
54
+ * Extends typical `renderItem` to include `columnIndex` and `columnSpan` (number of columns the item spans).
55
+ * `columnIndex` gives the consumer column information in case they might need to treat items differently based on column.
56
+ * This information may not otherwise be derived if using the `optimizeItemArrangement` feature, as the items will no
57
+ * longer be linearly distributed across the columns; instead they are allocated to the column with the least estimated height.
58
+ */
59
+ renderItem: MasonryListRenderItem<T> | null | undefined;
60
+ }
61
+
62
+ type OnScrollCallback = ScrollViewProps["onScroll"];
63
+ const defaultEstimatedItemSize = 100;
64
+
65
+ export interface MasonryFlashListScrollEvent extends NativeScrollEvent {
66
+ doNotPropagate?: boolean;
67
+ }
68
+
69
+ export interface MasonryListItem<T> {
70
+ originalIndex: number;
71
+ originalItem: T;
72
+ }
73
+
74
+ /**
75
+ * MasonryFlashListRef with support for scroll related methods
76
+ */
77
+ export interface MasonryFlashListRef<T> {
78
+ scrollToOffset: FlashList<T>["scrollToOffset"];
79
+ scrollToEnd: FlashList<T>["scrollToEnd"];
80
+ getScrollableNode: FlashList<T>["getScrollableNode"];
81
+ }
82
+
83
+ /**
84
+ * FlashList variant that enables rendering of masonry layouts.
85
+ * If you want `MasonryFlashList` to optimize item arrangement, enable `optimizeItemArrangement` and pass a valid `overrideItemLayout` function.
86
+ */
87
+ const MasonryFlashListComponent = React.forwardRef(
88
+ <T,>(
89
+ /**
90
+ * Forward Ref will force cast generic parament T to unknown. Export has a explicit cast to solve this.
91
+ */
92
+ props: MasonryFlashListProps<T>,
93
+ forwardRef: React.ForwardedRef<MasonryFlashListRef<T>>
94
+ ) => {
95
+ const columnCount = props.numColumns || 1;
96
+ const drawDistance = props.drawDistance;
97
+ const estimatedListSize = props.estimatedListSize ??
98
+ Dimensions.get("window") ?? { height: 500, width: 500 };
99
+
100
+ if (props.optimizeItemArrangement && !props.overrideItemLayout) {
101
+ throw new CustomError(
102
+ ExceptionList.overrideItemLayoutRequiredForMasonryOptimization
103
+ );
104
+ }
105
+ const dataSet = useDataSet(
106
+ columnCount,
107
+ Boolean(props.optimizeItemArrangement),
108
+ props.data,
109
+ props.overrideItemLayout,
110
+ props.extraData
111
+ );
112
+
113
+ const totalColumnFlex = useTotalColumnFlex(dataSet, props);
114
+
115
+ const onScrollRef = useRef<OnScrollCallback[]>([]);
116
+ const emptyScrollEvent = useRef(getEmptyScrollEvent())
117
+ .current as NativeSyntheticEvent<MasonryFlashListScrollEvent>;
118
+ const ScrollComponent = useRef(
119
+ getFlashListScrollView(onScrollRef, () => {
120
+ return (
121
+ getListRenderedSize(parentFlashList)?.height ||
122
+ estimatedListSize.height
123
+ );
124
+ })
125
+ ).current;
126
+
127
+ const onScrollProxy = useRef<OnScrollCallback>(
128
+ (scrollEvent: NativeSyntheticEvent<MasonryFlashListScrollEvent>) => {
129
+ emptyScrollEvent.nativeEvent.contentOffset.y =
130
+ scrollEvent.nativeEvent.contentOffset.y -
131
+ (parentFlashList.current?.firstItemOffset ?? 0);
132
+ onScrollRef.current?.forEach((onScrollCallback) => {
133
+ onScrollCallback?.(emptyScrollEvent);
134
+ });
135
+ if (!scrollEvent.nativeEvent.doNotPropagate) {
136
+ props.onScroll?.(scrollEvent);
137
+ }
138
+ }
139
+ ).current;
140
+
141
+ /**
142
+ * We're triggering an onScroll on internal lists so that they register the correct offset which is offset - header size.
143
+ * This will make sure viewability callbacks are triggered correctly.
144
+ * 32 ms is equal to two frames at 60 fps. Faster framerates will not cause any problems.
145
+ */
146
+ const onLoadForNestedLists = useRef((args: { elapsedTimeInMs: number }) => {
147
+ setTimeout(() => {
148
+ emptyScrollEvent.nativeEvent.doNotPropagate = true;
149
+ onScrollProxy?.(emptyScrollEvent);
150
+ emptyScrollEvent.nativeEvent.doNotPropagate = false;
151
+ }, 32);
152
+ props.onLoad?.(args);
153
+ }).current;
154
+
155
+ const [parentFlashList, getFlashList] =
156
+ useRefWithForwardRef<FlashList<MasonryListItem<T>[]>>(forwardRef);
157
+
158
+ const {
159
+ renderItem,
160
+ getItemType,
161
+ getColumnFlex,
162
+ overrideItemLayout,
163
+ viewabilityConfig,
164
+ keyExtractor,
165
+ onLoad,
166
+ onViewableItemsChanged,
167
+ data,
168
+ stickyHeaderIndices,
169
+ CellRendererComponent,
170
+ ItemSeparatorComponent,
171
+ ...remainingProps
172
+ } = props;
173
+
174
+ const firstColumnHeight =
175
+ (dataSet[0]?.length ?? 0) *
176
+ (props.estimatedItemSize ?? defaultEstimatedItemSize);
177
+
178
+ return (
179
+ <FlashList
180
+ ref={getFlashList}
181
+ {...remainingProps}
182
+ horizontal={false}
183
+ numColumns={columnCount}
184
+ data={dataSet}
185
+ onScroll={onScrollProxy}
186
+ estimatedItemSize={firstColumnHeight || estimatedListSize.height}
187
+ renderItem={(args) => {
188
+ return (
189
+ <FlashList
190
+ renderScrollComponent={ScrollComponent}
191
+ estimatedItemSize={props.estimatedItemSize}
192
+ data={args.item}
193
+ onLoad={args.index === 0 ? onLoadForNestedLists : undefined}
194
+ renderItem={(innerArgs) => {
195
+ return (
196
+ renderItem?.({
197
+ ...innerArgs,
198
+ item: innerArgs.item.originalItem,
199
+ index: innerArgs.item.originalIndex,
200
+ columnSpan: 1,
201
+ columnIndex: args.index,
202
+ }) ?? null
203
+ );
204
+ }}
205
+ keyExtractor={
206
+ keyExtractor
207
+ ? (item, _) => {
208
+ return keyExtractor?.(
209
+ item.originalItem,
210
+ item.originalIndex
211
+ );
212
+ }
213
+ : undefined
214
+ }
215
+ getItemType={
216
+ getItemType
217
+ ? (item, _, extraData) => {
218
+ return getItemType?.(
219
+ item.originalItem,
220
+ item.originalIndex,
221
+ extraData
222
+ );
223
+ }
224
+ : undefined
225
+ }
226
+ drawDistance={drawDistance}
227
+ estimatedListSize={{
228
+ height: estimatedListSize.height,
229
+ width:
230
+ ((getListRenderedSize(parentFlashList)?.width ||
231
+ estimatedListSize.width) /
232
+ totalColumnFlex) *
233
+ (getColumnFlex?.(
234
+ args.item,
235
+ args.index,
236
+ columnCount,
237
+ props.extraData
238
+ ) ?? 1),
239
+ }}
240
+ extraData={props.extraData}
241
+ CellRendererComponent={CellRendererComponent}
242
+ ItemSeparatorComponent={ItemSeparatorComponent}
243
+ viewabilityConfig={viewabilityConfig}
244
+ onViewableItemsChanged={
245
+ onViewableItemsChanged
246
+ ? (info) => {
247
+ updateViewTokens(info.viewableItems);
248
+ updateViewTokens(info.changed);
249
+ onViewableItemsChanged?.(info);
250
+ }
251
+ : undefined
252
+ }
253
+ overrideItemLayout={
254
+ overrideItemLayout
255
+ ? (layout, item, _, __, extraData) => {
256
+ overrideItemLayout?.(
257
+ layout,
258
+ item.originalItem,
259
+ item.originalIndex,
260
+ columnCount,
261
+ extraData
262
+ );
263
+ layout.span = undefined;
264
+ }
265
+ : undefined
266
+ }
267
+ />
268
+ );
269
+ }}
270
+ overrideItemLayout={
271
+ getColumnFlex
272
+ ? (layout, item, index, maxColumns, extraData) => {
273
+ layout.span =
274
+ (columnCount *
275
+ getColumnFlex(item, index, maxColumns, extraData)) /
276
+ totalColumnFlex;
277
+ }
278
+ : undefined
279
+ }
280
+ />
281
+ );
282
+ }
283
+ );
284
+
285
+ /**
286
+ * Splits data for each column's FlashList
287
+ */
288
+ const useDataSet = <T,>(
289
+ columnCount: number,
290
+ optimizeItemArrangement: boolean,
291
+ sourceData?: FlashListProps<T>["data"],
292
+ overrideItemLayout?: MasonryFlashListProps<T>["overrideItemLayout"],
293
+ extraData?: MasonryFlashListProps<T>["extraData"]
294
+ ): MasonryListItem<T>[][] => {
295
+ return useMemo(() => {
296
+ if (!sourceData || sourceData.length === 0) {
297
+ return [];
298
+ }
299
+ const columnHeightTracker = new Array<number>(columnCount).fill(0);
300
+ const layoutObject: { size: number | undefined } = { size: undefined };
301
+ const dataSet = new Array<MasonryListItem<T>[]>(columnCount);
302
+ const dataSize = sourceData.length;
303
+
304
+ for (let i = 0; i < columnCount; i++) {
305
+ dataSet[i] = [];
306
+ }
307
+ for (let i = 0; i < dataSize; i++) {
308
+ let nextColumnIndex = i % columnCount;
309
+ if (optimizeItemArrangement) {
310
+ for (let j = 0; j < columnCount; j++) {
311
+ if (columnHeightTracker[j] < columnHeightTracker[nextColumnIndex]) {
312
+ nextColumnIndex = j;
313
+ }
314
+ }
315
+ // update height of column
316
+ layoutObject.size = undefined;
317
+ overrideItemLayout!(
318
+ layoutObject,
319
+ sourceData[i],
320
+ i,
321
+ columnCount,
322
+ extraData
323
+ );
324
+ columnHeightTracker[nextColumnIndex] +=
325
+ layoutObject.size ?? defaultEstimatedItemSize;
326
+ }
327
+ dataSet[nextColumnIndex].push({
328
+ originalItem: sourceData[i],
329
+ originalIndex: i,
330
+ });
331
+ }
332
+ return dataSet;
333
+ // eslint-disable-next-line react-hooks/exhaustive-deps
334
+ }, [sourceData, columnCount, optimizeItemArrangement, extraData]);
335
+ };
336
+
337
+ const useTotalColumnFlex = <T,>(
338
+ dataSet: MasonryListItem<T>[][],
339
+ props: MasonryFlashListProps<T>
340
+ ): number => {
341
+ return useMemo(() => {
342
+ const columnCount = props.numColumns || 1;
343
+ if (!props.getColumnFlex) {
344
+ return columnCount;
345
+ }
346
+ let totalFlexSum = 0;
347
+ const dataSize = dataSet.length;
348
+ for (let i = 0; i < dataSize; i++) {
349
+ totalFlexSum += props.getColumnFlex(
350
+ dataSet[i],
351
+ i,
352
+ columnCount,
353
+ props.extraData
354
+ );
355
+ }
356
+ return totalFlexSum;
357
+ // eslint-disable-next-line react-hooks/exhaustive-deps
358
+ }, [dataSet, props.getColumnFlex, props.extraData]);
359
+ };
360
+
361
+ /**
362
+ * Handle both function refs and refs with current property
363
+ */
364
+ const useRefWithForwardRef = <T,>(
365
+ forwardRef: any
366
+ ): [React.MutableRefObject<T | null>, (instance: T | null) => void] => {
367
+ const ref: React.MutableRefObject<T | null> = useRef(null);
368
+ return [
369
+ ref,
370
+ useCallback(
371
+ (instance: T | null) => {
372
+ ref.current = instance;
373
+ if (typeof forwardRef === "function") {
374
+ forwardRef(instance);
375
+ } else if (forwardRef) {
376
+ forwardRef.current = instance;
377
+ }
378
+ },
379
+ [forwardRef]
380
+ ),
381
+ ];
382
+ };
383
+
384
+ /**
385
+ * This ScrollView is actually just a view mimicking a scrollview. We block the onScroll event from being passed to the parent list directly.
386
+ * We manually drive onScroll from the parent and thus, achieve recycling.
387
+ */
388
+ const getFlashListScrollView = (
389
+ onScrollRef: React.RefObject<OnScrollCallback[]>,
390
+ getParentHeight: () => number
391
+ ) => {
392
+ const FlashListScrollView = React.forwardRef(
393
+ (props: ScrollViewProps, ref: React.ForwardedRef<View>) => {
394
+ const { onLayout, onScroll, ...rest } = props;
395
+ const onLayoutProxy = useCallback(
396
+ (layoutEvent: LayoutChangeEvent) => {
397
+ onLayout?.({
398
+ nativeEvent: {
399
+ layout: {
400
+ height: getParentHeight(),
401
+ width: layoutEvent.nativeEvent.layout.width,
402
+ },
403
+ },
404
+ } as LayoutChangeEvent);
405
+ },
406
+ [onLayout]
407
+ );
408
+ useEffect(() => {
409
+ if (onScroll) {
410
+ onScrollRef.current?.push(onScroll);
411
+ }
412
+ return () => {
413
+ if (!onScrollRef.current || !onScroll) {
414
+ return;
415
+ }
416
+ const indexToDelete = onScrollRef.current.indexOf(onScroll);
417
+ if (indexToDelete > -1) {
418
+ onScrollRef.current.splice(indexToDelete, 1);
419
+ }
420
+ };
421
+ }, [onScroll]);
422
+ return <View ref={ref} {...rest} onLayout={onLayoutProxy} />;
423
+ }
424
+ );
425
+ FlashListScrollView.displayName = "FlashListScrollView";
426
+ return FlashListScrollView;
427
+ };
428
+ const updateViewTokens = (tokens: ViewToken[]) => {
429
+ const length = tokens.length;
430
+ for (let i = 0; i < length; i++) {
431
+ const token = tokens[i];
432
+ if (token.index !== null && token.index !== undefined) {
433
+ token.index = token.item.originalIndex;
434
+ token.item = token.item.originalItem;
435
+ }
436
+ }
437
+ };
438
+
439
+ const getEmptyScrollEvent = () => {
440
+ return {
441
+ nativeEvent: { contentOffset: { y: 0, x: 0 } },
442
+ };
443
+ };
444
+ const getListRenderedSize = <T,>(
445
+ parentFlashList: React.MutableRefObject<FlashList<T[]> | null>
446
+ ) => {
447
+ return parentFlashList?.current?.recyclerlistview_unsafe?.getRenderedSize();
448
+ };
449
+ MasonryFlashListComponent.displayName = "MasonryFlashList";
450
+
451
+ /**
452
+ * FlashList variant that enables rendering of masonry layouts.
453
+ * If you want `MasonryFlashList` to optimize item arrangement, enable `optimizeItemArrangement` and pass a valid `overrideItemLayout` function.
454
+ */
455
+ export const MasonryFlashList = MasonryFlashListComponent as <T>(
456
+ props: MasonryFlashListProps<T> & {
457
+ ref?: React.RefObject<MasonryFlashListRef<T>>;
458
+ }
459
+ ) => React.ReactElement;