@react-native-ohos/flash-list 1.8.3 → 2.1.1-rc.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 (455) hide show
  1. package/LICENSE +1 -1
  2. package/README.OpenSource +1 -1
  3. package/dist/AnimatedFlashList.d.ts +4 -28
  4. package/dist/AnimatedFlashList.d.ts.map +1 -1
  5. package/dist/AnimatedFlashList.js +5 -30
  6. package/dist/AnimatedFlashList.js.map +1 -1
  7. package/dist/FlashList.d.ts +1 -179
  8. package/dist/FlashList.d.ts.map +1 -1
  9. package/dist/FlashList.js +1 -599
  10. package/dist/FlashList.js.map +1 -1
  11. package/dist/FlashListProps.d.ts +285 -278
  12. package/dist/FlashListProps.d.ts.map +1 -1
  13. package/dist/FlashListProps.js +5 -31
  14. package/dist/FlashListProps.js.map +1 -1
  15. package/dist/FlashListRef.d.ts +305 -0
  16. package/dist/FlashListRef.d.ts.map +1 -0
  17. package/dist/FlashListRef.js +2 -0
  18. package/dist/FlashListRef.js.map +1 -0
  19. package/dist/benchmark/AutoScrollHelper.d.ts +17 -40
  20. package/dist/benchmark/AutoScrollHelper.d.ts.map +1 -1
  21. package/dist/benchmark/AutoScrollHelper.js +59 -90
  22. package/dist/benchmark/AutoScrollHelper.js.map +1 -1
  23. package/dist/benchmark/JSFPSMonitor.d.ts +22 -45
  24. package/dist/benchmark/JSFPSMonitor.d.ts.map +1 -1
  25. package/dist/benchmark/JSFPSMonitor.js +59 -87
  26. package/dist/benchmark/JSFPSMonitor.js.map +1 -1
  27. package/dist/benchmark/roundToDecimalPlaces.d.ts +1 -24
  28. package/dist/benchmark/roundToDecimalPlaces.d.ts.map +1 -1
  29. package/dist/benchmark/roundToDecimalPlaces.js +4 -31
  30. package/dist/benchmark/roundToDecimalPlaces.js.map +1 -1
  31. package/dist/benchmark/useBenchmark.d.ts +40 -57
  32. package/dist/benchmark/useBenchmark.d.ts.map +1 -1
  33. package/dist/benchmark/useBenchmark.js +119 -189
  34. package/dist/benchmark/useBenchmark.js.map +1 -1
  35. package/dist/benchmark/useDataMultiplier.d.ts +8 -31
  36. package/dist/benchmark/useDataMultiplier.d.ts.map +1 -1
  37. package/dist/benchmark/useDataMultiplier.js +19 -47
  38. package/dist/benchmark/useDataMultiplier.js.map +1 -1
  39. package/dist/benchmark/useFlatListBenchmark.d.ts +14 -35
  40. package/dist/benchmark/useFlatListBenchmark.d.ts.map +1 -1
  41. package/dist/benchmark/useFlatListBenchmark.js +92 -122
  42. package/dist/benchmark/useFlatListBenchmark.js.map +1 -1
  43. package/dist/errors/ErrorMessages.d.ts +16 -0
  44. package/dist/errors/ErrorMessages.d.ts.map +1 -0
  45. package/dist/errors/ErrorMessages.js +16 -0
  46. package/dist/errors/ErrorMessages.js.map +1 -0
  47. package/dist/errors/WarningMessages.d.ts +6 -0
  48. package/dist/errors/WarningMessages.d.ts.map +1 -0
  49. package/dist/errors/WarningMessages.js +7 -0
  50. package/dist/errors/WarningMessages.js.map +1 -0
  51. package/dist/index.d.ts +15 -36
  52. package/dist/index.d.ts.map +1 -1
  53. package/dist/index.js +19 -54
  54. package/dist/index.js.map +1 -1
  55. package/dist/isNewArch.d.ts +2 -0
  56. package/dist/isNewArch.d.ts.map +1 -0
  57. package/dist/isNewArch.js +22 -0
  58. package/dist/isNewArch.js.map +1 -0
  59. package/dist/native/config/PlatformHelper.android.d.ts +6 -48
  60. package/dist/native/config/PlatformHelper.android.d.ts.map +1 -1
  61. package/dist/native/config/PlatformHelper.android.js +6 -45
  62. package/dist/native/config/PlatformHelper.android.js.map +1 -1
  63. package/dist/native/config/PlatformHelper.d.ts +6 -48
  64. package/dist/native/config/PlatformHelper.d.ts.map +1 -1
  65. package/dist/native/config/PlatformHelper.harmony.d.ts +29 -48
  66. package/dist/native/config/PlatformHelper.harmony.d.ts.map +1 -1
  67. package/dist/native/config/PlatformHelper.harmony.js +29 -44
  68. package/dist/native/config/PlatformHelper.harmony.js.map +1 -1
  69. package/dist/native/config/PlatformHelper.ios.d.ts +6 -48
  70. package/dist/native/config/PlatformHelper.ios.d.ts.map +1 -1
  71. package/dist/native/config/PlatformHelper.ios.js +6 -44
  72. package/dist/native/config/PlatformHelper.ios.js.map +1 -1
  73. package/dist/native/config/PlatformHelper.js +6 -45
  74. package/dist/native/config/PlatformHelper.js.map +1 -1
  75. package/dist/native/config/PlatformHelper.web.d.ts +6 -49
  76. package/dist/native/config/PlatformHelper.web.d.ts.map +1 -1
  77. package/dist/native/config/PlatformHelper.web.js +6 -47
  78. package/dist/native/config/PlatformHelper.web.js.map +1 -1
  79. package/dist/recyclerview/LayoutCommitObserver.d.ts +12 -0
  80. package/dist/recyclerview/LayoutCommitObserver.d.ts.map +1 -0
  81. package/dist/recyclerview/LayoutCommitObserver.js +58 -0
  82. package/dist/recyclerview/LayoutCommitObserver.js.map +1 -0
  83. package/dist/recyclerview/RecyclerView.d.ts +13 -0
  84. package/dist/recyclerview/RecyclerView.d.ts.map +1 -0
  85. package/dist/recyclerview/RecyclerView.js +368 -0
  86. package/dist/recyclerview/RecyclerView.js.map +1 -0
  87. package/dist/recyclerview/RecyclerViewContextProvider.d.ts +46 -0
  88. package/dist/recyclerview/RecyclerViewContextProvider.d.ts.map +1 -0
  89. package/dist/recyclerview/RecyclerViewContextProvider.js +10 -0
  90. package/dist/recyclerview/RecyclerViewContextProvider.js.map +1 -0
  91. package/dist/recyclerview/RecyclerViewManager.d.ts +78 -0
  92. package/dist/recyclerview/RecyclerViewManager.d.ts.map +1 -0
  93. package/dist/recyclerview/RecyclerViewManager.js +343 -0
  94. package/dist/recyclerview/RecyclerViewManager.js.map +1 -0
  95. package/dist/recyclerview/RecyclerViewProps.d.ts +2 -0
  96. package/dist/recyclerview/RecyclerViewProps.d.ts.map +1 -0
  97. package/dist/recyclerview/RecyclerViewProps.js +2 -0
  98. package/dist/recyclerview/RecyclerViewProps.js.map +1 -0
  99. package/dist/recyclerview/RenderStackManager.d.ts +86 -0
  100. package/dist/recyclerview/RenderStackManager.d.ts.map +1 -0
  101. package/dist/recyclerview/RenderStackManager.js +252 -0
  102. package/dist/recyclerview/RenderStackManager.js.map +1 -0
  103. package/dist/recyclerview/ViewHolder.d.ts +45 -0
  104. package/dist/recyclerview/ViewHolder.d.ts.map +1 -0
  105. package/dist/recyclerview/ViewHolder.js +94 -0
  106. package/dist/recyclerview/ViewHolder.js.map +1 -0
  107. package/dist/recyclerview/ViewHolderCollection.d.ts +63 -0
  108. package/dist/recyclerview/ViewHolderCollection.d.ts.map +1 -0
  109. package/dist/recyclerview/ViewHolderCollection.js +87 -0
  110. package/dist/recyclerview/ViewHolderCollection.js.map +1 -0
  111. package/dist/recyclerview/components/CompatScroller.d.ts +7 -0
  112. package/dist/recyclerview/components/CompatScroller.d.ts.map +1 -0
  113. package/dist/recyclerview/components/CompatScroller.js +7 -0
  114. package/dist/recyclerview/components/CompatScroller.js.map +1 -0
  115. package/dist/recyclerview/components/CompatView.d.ts +7 -0
  116. package/dist/recyclerview/components/CompatView.d.ts.map +1 -0
  117. package/dist/recyclerview/components/CompatView.js +7 -0
  118. package/dist/recyclerview/components/CompatView.js.map +1 -0
  119. package/dist/recyclerview/components/ScrollAnchor.d.ts +29 -0
  120. package/dist/recyclerview/components/ScrollAnchor.d.ts.map +1 -0
  121. package/dist/recyclerview/components/ScrollAnchor.js +33 -0
  122. package/dist/recyclerview/components/ScrollAnchor.js.map +1 -0
  123. package/dist/recyclerview/components/StickyHeaders.d.ts +38 -0
  124. package/dist/recyclerview/components/StickyHeaders.d.ts.map +1 -0
  125. package/dist/recyclerview/components/StickyHeaders.js +112 -0
  126. package/dist/recyclerview/components/StickyHeaders.js.map +1 -0
  127. package/dist/recyclerview/helpers/ConsecutiveNumbers.d.ts +51 -0
  128. package/dist/recyclerview/helpers/ConsecutiveNumbers.d.ts.map +1 -0
  129. package/dist/recyclerview/helpers/ConsecutiveNumbers.js +95 -0
  130. package/dist/recyclerview/helpers/ConsecutiveNumbers.js.map +1 -0
  131. package/dist/recyclerview/helpers/EngagedIndicesTracker.d.ts +105 -0
  132. package/dist/recyclerview/helpers/EngagedIndicesTracker.d.ts.map +1 -0
  133. package/dist/recyclerview/helpers/EngagedIndicesTracker.js +202 -0
  134. package/dist/recyclerview/helpers/EngagedIndicesTracker.js.map +1 -0
  135. package/dist/recyclerview/helpers/RenderTimeTracker.d.ts +14 -0
  136. package/dist/recyclerview/helpers/RenderTimeTracker.d.ts.map +1 -0
  137. package/dist/recyclerview/helpers/RenderTimeTracker.js +44 -0
  138. package/dist/recyclerview/helpers/RenderTimeTracker.js.map +1 -0
  139. package/dist/recyclerview/helpers/VelocityTracker.d.ts +29 -0
  140. package/dist/recyclerview/helpers/VelocityTracker.d.ts.map +1 -0
  141. package/dist/recyclerview/helpers/VelocityTracker.js +64 -0
  142. package/dist/recyclerview/helpers/VelocityTracker.js.map +1 -0
  143. package/dist/recyclerview/hooks/useBoundDetection.d.ts +17 -0
  144. package/dist/recyclerview/hooks/useBoundDetection.d.ts.map +1 -0
  145. package/dist/recyclerview/hooks/useBoundDetection.js +132 -0
  146. package/dist/recyclerview/hooks/useBoundDetection.js.map +1 -0
  147. package/dist/recyclerview/hooks/useLayoutState.d.ts +14 -0
  148. package/dist/recyclerview/hooks/useLayoutState.d.ts.map +1 -0
  149. package/dist/recyclerview/hooks/useLayoutState.js +38 -0
  150. package/dist/recyclerview/hooks/useLayoutState.js.map +1 -0
  151. package/dist/recyclerview/hooks/useMappingHelper.d.ts +9 -0
  152. package/dist/recyclerview/hooks/useMappingHelper.d.ts.map +1 -0
  153. package/dist/recyclerview/hooks/useMappingHelper.js +15 -0
  154. package/dist/recyclerview/hooks/useMappingHelper.js.map +1 -0
  155. package/dist/recyclerview/hooks/useOnLoad.d.ts +25 -0
  156. package/dist/recyclerview/hooks/useOnLoad.d.ts.map +1 -0
  157. package/dist/recyclerview/hooks/useOnLoad.js +67 -0
  158. package/dist/recyclerview/hooks/useOnLoad.js.map +1 -0
  159. package/dist/recyclerview/hooks/useRecyclerViewController.d.ts +28 -0
  160. package/dist/recyclerview/hooks/useRecyclerViewController.d.ts.map +1 -0
  161. package/dist/recyclerview/hooks/useRecyclerViewController.js +507 -0
  162. package/dist/recyclerview/hooks/useRecyclerViewController.js.map +1 -0
  163. package/dist/recyclerview/hooks/useRecyclerViewManager.d.ts +8 -0
  164. package/dist/recyclerview/hooks/useRecyclerViewManager.d.ts.map +1 -0
  165. package/dist/recyclerview/hooks/useRecyclerViewManager.js +32 -0
  166. package/dist/recyclerview/hooks/useRecyclerViewManager.js.map +1 -0
  167. package/dist/recyclerview/hooks/useRecyclingState.d.ts +18 -0
  168. package/dist/recyclerview/hooks/useRecyclingState.d.ts.map +1 -0
  169. package/dist/recyclerview/hooks/useRecyclingState.js +49 -0
  170. package/dist/recyclerview/hooks/useRecyclingState.js.map +1 -0
  171. package/dist/recyclerview/hooks/useSecondaryProps.d.ts +27 -0
  172. package/dist/recyclerview/hooks/useSecondaryProps.d.ts.map +1 -0
  173. package/dist/recyclerview/hooks/useSecondaryProps.js +90 -0
  174. package/dist/recyclerview/hooks/useSecondaryProps.js.map +1 -0
  175. package/dist/recyclerview/hooks/useUnmountAwareCallbacks.d.ts +15 -0
  176. package/dist/recyclerview/hooks/useUnmountAwareCallbacks.d.ts.map +1 -0
  177. package/dist/recyclerview/hooks/useUnmountAwareCallbacks.js +58 -0
  178. package/dist/recyclerview/hooks/useUnmountAwareCallbacks.js.map +1 -0
  179. package/dist/recyclerview/hooks/useUnmountFlag.d.ts +10 -0
  180. package/dist/recyclerview/hooks/useUnmountFlag.d.ts.map +1 -0
  181. package/dist/recyclerview/hooks/useUnmountFlag.js +25 -0
  182. package/dist/recyclerview/hooks/useUnmountFlag.js.map +1 -0
  183. package/dist/recyclerview/layout-managers/GridLayoutManager.d.ts +79 -0
  184. package/dist/recyclerview/layout-managers/GridLayoutManager.d.ts.map +1 -0
  185. package/dist/recyclerview/layout-managers/GridLayoutManager.js +221 -0
  186. package/dist/recyclerview/layout-managers/GridLayoutManager.js.map +1 -0
  187. package/dist/recyclerview/layout-managers/LayoutManager.d.ts +296 -0
  188. package/dist/recyclerview/layout-managers/LayoutManager.d.ts.map +1 -0
  189. package/dist/recyclerview/layout-managers/LayoutManager.js +279 -0
  190. package/dist/recyclerview/layout-managers/LayoutManager.js.map +1 -0
  191. package/dist/recyclerview/layout-managers/LinearLayoutManager.d.ts +51 -0
  192. package/dist/recyclerview/layout-managers/LinearLayoutManager.d.ts.map +1 -0
  193. package/dist/recyclerview/layout-managers/LinearLayoutManager.js +151 -0
  194. package/dist/recyclerview/layout-managers/LinearLayoutManager.js.map +1 -0
  195. package/dist/recyclerview/layout-managers/MasonryLayoutManager.d.ts +81 -0
  196. package/dist/recyclerview/layout-managers/MasonryLayoutManager.d.ts.map +1 -0
  197. package/dist/recyclerview/layout-managers/MasonryLayoutManager.js +269 -0
  198. package/dist/recyclerview/layout-managers/MasonryLayoutManager.js.map +1 -0
  199. package/dist/recyclerview/utils/adjustOffsetForRTL.d.ts +12 -0
  200. package/dist/recyclerview/utils/adjustOffsetForRTL.d.ts.map +1 -0
  201. package/dist/recyclerview/utils/adjustOffsetForRTL.js +14 -0
  202. package/dist/recyclerview/utils/adjustOffsetForRTL.js.map +1 -0
  203. package/dist/recyclerview/utils/componentUtils.d.ts +19 -0
  204. package/dist/recyclerview/utils/componentUtils.d.ts.map +1 -0
  205. package/dist/recyclerview/utils/componentUtils.js +27 -0
  206. package/dist/recyclerview/utils/componentUtils.js.map +1 -0
  207. package/dist/recyclerview/utils/findVisibleIndex.d.ts +24 -0
  208. package/dist/recyclerview/utils/findVisibleIndex.d.ts.map +1 -0
  209. package/dist/recyclerview/utils/findVisibleIndex.js +76 -0
  210. package/dist/recyclerview/utils/findVisibleIndex.js.map +1 -0
  211. package/dist/recyclerview/utils/measureLayout.d.ts +52 -0
  212. package/dist/recyclerview/utils/measureLayout.d.ts.map +1 -0
  213. package/dist/recyclerview/utils/measureLayout.js +99 -0
  214. package/dist/recyclerview/utils/measureLayout.js.map +1 -0
  215. package/dist/recyclerview/utils/measureLayout.web.d.ts +29 -0
  216. package/dist/recyclerview/utils/measureLayout.web.d.ts.map +1 -0
  217. package/dist/recyclerview/utils/measureLayout.web.js +79 -0
  218. package/dist/recyclerview/utils/measureLayout.web.js.map +1 -0
  219. package/dist/recyclerview/viewability/ViewToken.d.ts +8 -0
  220. package/dist/recyclerview/viewability/ViewToken.d.ts.map +1 -0
  221. package/dist/recyclerview/viewability/ViewToken.js +2 -0
  222. package/dist/recyclerview/viewability/ViewToken.js.map +1 -0
  223. package/dist/recyclerview/viewability/ViewabilityHelper.d.ts +26 -0
  224. package/dist/recyclerview/viewability/ViewabilityHelper.d.ts.map +1 -0
  225. package/dist/recyclerview/viewability/ViewabilityHelper.js +98 -0
  226. package/dist/recyclerview/viewability/ViewabilityHelper.js.map +1 -0
  227. package/dist/recyclerview/viewability/ViewabilityManager.d.ts +25 -0
  228. package/dist/recyclerview/viewability/ViewabilityManager.d.ts.map +1 -0
  229. package/dist/recyclerview/viewability/ViewabilityManager.js +94 -0
  230. package/dist/recyclerview/viewability/ViewabilityManager.js.map +1 -0
  231. package/dist/tsconfig.tsbuildinfo +1 -1
  232. package/dist/utils/AverageWindow.d.ts +33 -43
  233. package/dist/utils/AverageWindow.d.ts.map +1 -1
  234. package/dist/utils/AverageWindow.js +66 -71
  235. package/dist/utils/AverageWindow.js.map +1 -1
  236. package/jestSetup.js +23 -37
  237. package/package.json +15 -24
  238. package/src/AnimatedFlashList.ts +2 -25
  239. package/src/FlashList.ts +1 -0
  240. package/src/FlashListProps.ts +109 -100
  241. package/src/FlashListRef.ts +320 -0
  242. package/src/benchmark/AutoScrollHelper.ts +0 -24
  243. package/src/benchmark/JSFPSMonitor.ts +2 -26
  244. package/src/benchmark/roundToDecimalPlaces.ts +0 -24
  245. package/src/benchmark/useBenchmark.ts +59 -105
  246. package/src/benchmark/useDataMultiplier.ts +0 -24
  247. package/src/benchmark/useFlatListBenchmark.ts +43 -32
  248. package/src/errors/ErrorMessages.ts +26 -0
  249. package/src/errors/WarningMessages.ts +9 -0
  250. package/src/index.ts +18 -46
  251. package/src/isNewArch.ts +25 -0
  252. package/src/native/config/PlatformHelper.android.ts +3 -49
  253. package/src/native/config/PlatformHelper.harmony.ts +3 -24
  254. package/src/native/config/PlatformHelper.ios.ts +3 -48
  255. package/src/native/config/PlatformHelper.ts +3 -49
  256. package/src/native/config/PlatformHelper.web.ts +4 -55
  257. package/src/recyclerview/LayoutCommitObserver.tsx +74 -0
  258. package/src/recyclerview/RecyclerView.tsx +616 -0
  259. package/src/recyclerview/RecyclerViewContextProvider.ts +65 -0
  260. package/src/recyclerview/RecyclerViewManager.ts +461 -0
  261. package/src/recyclerview/RecyclerViewProps.ts +1 -0
  262. package/src/recyclerview/RenderStackManager.ts +317 -0
  263. package/src/recyclerview/ViewHolder.tsx +180 -0
  264. package/src/recyclerview/ViewHolderCollection.tsx +193 -0
  265. package/src/recyclerview/components/CompatScroller.ts +9 -0
  266. package/src/recyclerview/components/CompatView.ts +9 -0
  267. package/src/recyclerview/components/ScrollAnchor.tsx +66 -0
  268. package/src/recyclerview/components/StickyHeaders.tsx +222 -0
  269. package/src/recyclerview/helpers/ConsecutiveNumbers.ts +120 -0
  270. package/src/recyclerview/helpers/EngagedIndicesTracker.ts +301 -0
  271. package/src/recyclerview/helpers/RenderTimeTracker.ts +50 -0
  272. package/src/recyclerview/helpers/VelocityTracker.ts +77 -0
  273. package/src/recyclerview/hooks/useBoundDetection.ts +176 -0
  274. package/src/recyclerview/hooks/useLayoutState.ts +55 -0
  275. package/src/recyclerview/hooks/useMappingHelper.ts +20 -0
  276. package/src/recyclerview/hooks/useOnLoad.ts +80 -0
  277. package/src/recyclerview/hooks/useRecyclerViewController.tsx +633 -0
  278. package/src/recyclerview/hooks/useRecyclerViewManager.ts +42 -0
  279. package/src/recyclerview/hooks/useRecyclingState.ts +67 -0
  280. package/src/recyclerview/hooks/useSecondaryProps.tsx +124 -0
  281. package/src/recyclerview/hooks/useUnmountAwareCallbacks.ts +73 -0
  282. package/src/recyclerview/hooks/useUnmountFlag.ts +27 -0
  283. package/src/recyclerview/layout-managers/GridLayoutManager.ts +256 -0
  284. package/src/recyclerview/layout-managers/LayoutManager.ts +568 -0
  285. package/src/recyclerview/layout-managers/LinearLayoutManager.ts +171 -0
  286. package/src/recyclerview/layout-managers/MasonryLayoutManager.ts +323 -0
  287. package/src/recyclerview/utils/adjustOffsetForRTL.ts +17 -0
  288. package/src/recyclerview/utils/componentUtils.ts +28 -0
  289. package/src/recyclerview/utils/findVisibleIndex.ts +93 -0
  290. package/src/recyclerview/utils/measureLayout.ts +128 -0
  291. package/src/recyclerview/utils/measureLayout.web.ts +102 -0
  292. package/src/recyclerview/viewability/ViewToken.ts +7 -0
  293. package/src/{viewability → recyclerview/viewability}/ViewabilityHelper.ts +8 -33
  294. package/src/{viewability → recyclerview/viewability}/ViewabilityManager.ts +23 -46
  295. package/src/utils/AverageWindow.ts +33 -24
  296. package/dist/GridLayoutProviderWithProps.d.ts +0 -65
  297. package/dist/GridLayoutProviderWithProps.d.ts.map +0 -1
  298. package/dist/GridLayoutProviderWithProps.js +0 -138
  299. package/dist/GridLayoutProviderWithProps.js.map +0 -1
  300. package/dist/MasonryFlashList.d.ts +0 -74
  301. package/dist/MasonryFlashList.d.ts.map +0 -1
  302. package/dist/MasonryFlashList.js +0 -275
  303. package/dist/MasonryFlashList.js.map +0 -1
  304. package/dist/PureComponentWrapper.d.ts +0 -45
  305. package/dist/PureComponentWrapper.d.ts.map +0 -1
  306. package/dist/PureComponentWrapper.js +0 -60
  307. package/dist/PureComponentWrapper.js.map +0 -1
  308. package/dist/benchmark/useBlankAreaTracker.d.ts +0 -57
  309. package/dist/benchmark/useBlankAreaTracker.d.ts.map +0 -1
  310. package/dist/benchmark/useBlankAreaTracker.js +0 -90
  311. package/dist/benchmark/useBlankAreaTracker.js.map +0 -1
  312. package/dist/errors/CustomError.d.ts +0 -31
  313. package/dist/errors/CustomError.d.ts.map +0 -1
  314. package/dist/errors/CustomError.js +0 -37
  315. package/dist/errors/CustomError.js.map +0 -1
  316. package/dist/errors/ExceptionList.d.ts +0 -47
  317. package/dist/errors/ExceptionList.d.ts.map +0 -1
  318. package/dist/errors/ExceptionList.js +0 -49
  319. package/dist/errors/ExceptionList.js.map +0 -1
  320. package/dist/errors/Warnings.d.ts +0 -32
  321. package/dist/errors/Warnings.d.ts.map +0 -1
  322. package/dist/errors/Warnings.js +0 -36
  323. package/dist/errors/Warnings.js.map +0 -1
  324. package/dist/fabric/AutoLayoutNativeComponent.d.ts +0 -42
  325. package/dist/fabric/AutoLayoutNativeComponent.d.ts.map +0 -1
  326. package/dist/fabric/AutoLayoutNativeComponent.js +0 -29
  327. package/dist/fabric/AutoLayoutNativeComponent.js.map +0 -1
  328. package/dist/fabric/CellContainerNativeComponent.d.ts +0 -31
  329. package/dist/fabric/CellContainerNativeComponent.d.ts.map +0 -1
  330. package/dist/fabric/CellContainerNativeComponent.js +0 -29
  331. package/dist/fabric/CellContainerNativeComponent.js.map +0 -1
  332. package/dist/native/auto-layout/AutoLayoutView.d.ts +0 -45
  333. package/dist/native/auto-layout/AutoLayoutView.d.ts.map +0 -1
  334. package/dist/native/auto-layout/AutoLayoutView.js +0 -71
  335. package/dist/native/auto-layout/AutoLayoutView.js.map +0 -1
  336. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.d.ts +0 -27
  337. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.d.ts.map +0 -1
  338. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.js +0 -29
  339. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.js.map +0 -1
  340. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.d.ts +0 -28
  341. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.d.ts.map +0 -1
  342. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.d.ts +0 -27
  343. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.d.ts.map +0 -1
  344. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.js +0 -29
  345. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.js.map +0 -1
  346. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.d.ts +0 -27
  347. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.d.ts.map +0 -1
  348. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.js +0 -29
  349. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.js.map +0 -1
  350. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.js +0 -29
  351. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.js.map +0 -1
  352. package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.d.ts +0 -39
  353. package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.d.ts.map +0 -1
  354. package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.js +0 -26
  355. package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.js.map +0 -1
  356. package/dist/native/cell-container/CellContainer.android.d.ts +0 -29
  357. package/dist/native/cell-container/CellContainer.android.d.ts.map +0 -1
  358. package/dist/native/cell-container/CellContainer.android.js +0 -32
  359. package/dist/native/cell-container/CellContainer.android.js.map +0 -1
  360. package/dist/native/cell-container/CellContainer.d.ts +0 -31
  361. package/dist/native/cell-container/CellContainer.d.ts.map +0 -1
  362. package/dist/native/cell-container/CellContainer.harmony.d.ts +0 -29
  363. package/dist/native/cell-container/CellContainer.harmony.d.ts.map +0 -1
  364. package/dist/native/cell-container/CellContainer.harmony.js +0 -32
  365. package/dist/native/cell-container/CellContainer.harmony.js.map +0 -1
  366. package/dist/native/cell-container/CellContainer.ios.d.ts +0 -29
  367. package/dist/native/cell-container/CellContainer.ios.d.ts.map +0 -1
  368. package/dist/native/cell-container/CellContainer.ios.js +0 -32
  369. package/dist/native/cell-container/CellContainer.ios.js.map +0 -1
  370. package/dist/native/cell-container/CellContainer.js +0 -34
  371. package/dist/native/cell-container/CellContainer.js.map +0 -1
  372. package/dist/native/cell-container/CellContainer.web.d.ts +0 -30
  373. package/dist/native/cell-container/CellContainer.web.d.ts.map +0 -1
  374. package/dist/native/cell-container/CellContainer.web.js +0 -36
  375. package/dist/native/cell-container/CellContainer.web.js.map +0 -1
  376. package/dist/utils/ContentContainerUtils.d.ts +0 -50
  377. package/dist/utils/ContentContainerUtils.d.ts.map +0 -1
  378. package/dist/utils/ContentContainerUtils.js +0 -71
  379. package/dist/utils/ContentContainerUtils.js.map +0 -1
  380. package/dist/viewability/ViewToken.d.ts +0 -31
  381. package/dist/viewability/ViewToken.d.ts.map +0 -1
  382. package/dist/viewability/ViewToken.js +0 -26
  383. package/dist/viewability/ViewToken.js.map +0 -1
  384. package/dist/viewability/ViewabilityHelper.d.ts +0 -49
  385. package/dist/viewability/ViewabilityHelper.d.ts.map +0 -1
  386. package/dist/viewability/ViewabilityHelper.js +0 -130
  387. package/dist/viewability/ViewabilityHelper.js.map +0 -1
  388. package/dist/viewability/ViewabilityManager.d.ts +0 -48
  389. package/dist/viewability/ViewabilityManager.d.ts.map +0 -1
  390. package/dist/viewability/ViewabilityManager.js +0 -131
  391. package/dist/viewability/ViewabilityManager.js.map +0 -1
  392. package/harmony/flash_list/BuildProfile.ets +0 -17
  393. package/harmony/flash_list/LICENSE +0 -7
  394. package/harmony/flash_list/build-profile.json5 +0 -8
  395. package/harmony/flash_list/hvigorfile.ts +0 -1
  396. package/harmony/flash_list/index.ets +0 -27
  397. package/harmony/flash_list/obfuscation-rules.txt +0 -18
  398. package/harmony/flash_list/oh-package.json5 +0 -24
  399. package/harmony/flash_list/src/main/cpp/AutoLayoutNode.cpp +0 -63
  400. package/harmony/flash_list/src/main/cpp/AutoLayoutNode.h +0 -54
  401. package/harmony/flash_list/src/main/cpp/AutoLayoutShadow.cpp +0 -140
  402. package/harmony/flash_list/src/main/cpp/AutoLayoutShadow.h +0 -66
  403. package/harmony/flash_list/src/main/cpp/AutoLayoutViewComponentInstance.cpp +0 -208
  404. package/harmony/flash_list/src/main/cpp/AutoLayoutViewComponentInstance.h +0 -78
  405. package/harmony/flash_list/src/main/cpp/AutoLayoutViewEventEmitRequestHandler.h +0 -53
  406. package/harmony/flash_list/src/main/cpp/AutoLayoutViewJSIBinder.h +0 -50
  407. package/harmony/flash_list/src/main/cpp/CMakeLists.txt +0 -12
  408. package/harmony/flash_list/src/main/cpp/CellContainerComponentInstance.cpp +0 -80
  409. package/harmony/flash_list/src/main/cpp/CellContainerComponentInstance.h +0 -64
  410. package/harmony/flash_list/src/main/cpp/CellContainerJSIBinder.h +0 -39
  411. package/harmony/flash_list/src/main/cpp/ComponentDescriptors.h +0 -40
  412. package/harmony/flash_list/src/main/cpp/EventEmitters.cpp +0 -40
  413. package/harmony/flash_list/src/main/cpp/EventEmitters.h +0 -48
  414. package/harmony/flash_list/src/main/cpp/FlashListPackage.h +0 -85
  415. package/harmony/flash_list/src/main/cpp/FlashListStackNode.cpp +0 -87
  416. package/harmony/flash_list/src/main/cpp/FlashListStackNode.h +0 -57
  417. package/harmony/flash_list/src/main/cpp/Props.cpp +0 -52
  418. package/harmony/flash_list/src/main/cpp/Props.h +0 -64
  419. package/harmony/flash_list/src/main/cpp/ShadowNodes.cpp +0 -34
  420. package/harmony/flash_list/src/main/cpp/ShadowNodes.h +0 -48
  421. package/harmony/flash_list/src/main/ets/Logger.ets +0 -64
  422. package/harmony/flash_list/src/main/ets/RNAutoLayoutShadow.ets +0 -154
  423. package/harmony/flash_list/src/main/ets/RNAutoLayoutView.ets +0 -277
  424. package/harmony/flash_list/src/main/ets/RNCellContainer.ets +0 -113
  425. package/harmony/flash_list/src/main/module.json5 +0 -9
  426. package/harmony/flash_list/src/main/resources/base/element/color.json +0 -8
  427. package/harmony/flash_list/src/main/resources/base/element/string.json +0 -16
  428. package/harmony/flash_list/src/main/resources/base/media/icon.png +0 -0
  429. package/harmony/flash_list/src/main/resources/base/profile/main_pages.json +0 -5
  430. package/harmony/flash_list/src/main/resources/en_US/element/string.json +0 -16
  431. package/harmony/flash_list/src/main/resources/zh_CN/element/string.json +0 -16
  432. package/harmony/flash_list.har +0 -0
  433. package/src/FlashList.tsx +0 -949
  434. package/src/GridLayoutProviderWithProps.ts +0 -204
  435. package/src/MasonryFlashList.tsx +0 -499
  436. package/src/PureComponentWrapper.tsx +0 -65
  437. package/src/benchmark/useBlankAreaTracker.ts +0 -141
  438. package/src/errors/CustomError.ts +0 -34
  439. package/src/errors/ExceptionList.ts +0 -52
  440. package/src/errors/Warnings.ts +0 -39
  441. package/src/fabric/AutoLayoutNativeComponent.ts +0 -52
  442. package/src/fabric/CellContainerNativeComponent.ts +0 -35
  443. package/src/native/auto-layout/AutoLayoutView.tsx +0 -97
  444. package/src/native/auto-layout/AutoLayoutViewNativeComponent.android.ts +0 -31
  445. package/src/native/auto-layout/AutoLayoutViewNativeComponent.harmony.ts +0 -31
  446. package/src/native/auto-layout/AutoLayoutViewNativeComponent.ios.ts +0 -31
  447. package/src/native/auto-layout/AutoLayoutViewNativeComponent.ts +0 -31
  448. package/src/native/auto-layout/AutoLayoutViewNativeComponentProps.ts +0 -41
  449. package/src/native/cell-container/CellContainer.android.ts +0 -31
  450. package/src/native/cell-container/CellContainer.harmony.ts +0 -31
  451. package/src/native/cell-container/CellContainer.ios.ts +0 -31
  452. package/src/native/cell-container/CellContainer.tsx +0 -38
  453. package/src/native/cell-container/CellContainer.web.tsx +0 -33
  454. package/src/utils/ContentContainerUtils.ts +0 -116
  455. package/src/viewability/ViewToken.ts +0 -31
@@ -1,204 +0,0 @@
1
- /**
2
- * MIT License
3
- *
4
- * Copyright (C) 2024 Huawei Device Co., Ltd.
5
- *
6
- * Permission is hereby granted, free of charge, to any person obtaining a copy
7
- * of this software and associated documentation files (the "Software"), to deal
8
- * in the Software without restriction, including without limitation the rights
9
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
- * copies of the Software, and to permit persons to whom the Software is
11
- * furnished to do so, subject to the following conditions:
12
- *
13
- * The above copyright notice and this permission notice shall be included in all
14
- * copies or substantial portions of the Software.
15
- *
16
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
- * SOFTWARE.
23
- */
24
-
25
- import {
26
- Dimension,
27
- GridLayoutProvider,
28
- Layout,
29
- LayoutManager,
30
- } from "recyclerlistview";
31
-
32
- import { FlashListProps } from "./FlashListProps";
33
- import { AverageWindow } from "./utils/AverageWindow";
34
- import { applyContentContainerInsetForLayoutManager } from "./utils/ContentContainerUtils";
35
-
36
- export default class GridLayoutProviderWithProps<T> extends GridLayoutProvider {
37
- private props: FlashListProps<T>;
38
- private layoutObject = { span: undefined, size: undefined };
39
- private averageWindow: AverageWindow;
40
- private renderWindowInsets: Dimension = { width: 0, height: 0 };
41
- private _hasExpired = false;
42
- public defaultEstimatedItemSize = 100;
43
-
44
- constructor(
45
- maxSpan: number,
46
- getLayoutType: (
47
- index: number,
48
- props: FlashListProps<T>,
49
- mutableLayout: { span?: number; size?: number }
50
- ) => string | number,
51
- getSpan: (
52
- index: number,
53
- props: FlashListProps<T>,
54
- mutableLayout: { span?: number; size?: number }
55
- ) => number,
56
- getHeightOrWidth: (
57
- index: number,
58
- props: FlashListProps<T>,
59
- mutableLayout: { span?: number; size?: number }
60
- ) => number | undefined,
61
- props: FlashListProps<T>,
62
- acceptableRelayoutDelta?: number
63
- ) {
64
- super(
65
- maxSpan,
66
- (i) => {
67
- return getLayoutType(i, this.props, this.getCleanLayoutObj());
68
- },
69
- (i) => {
70
- return getSpan(i, this.props, this.getCleanLayoutObj());
71
- },
72
- (i) => {
73
- return (
74
- // Using average item size if no override has been provided by the developer
75
- getHeightOrWidth(i, this.props, this.getCleanLayoutObj()) ??
76
- this.averageItemSize
77
- );
78
- },
79
- acceptableRelayoutDelta
80
- );
81
- this.props = props;
82
- this.averageWindow = new AverageWindow(
83
- 1,
84
- props.estimatedItemSize ?? this.defaultEstimatedItemSize
85
- );
86
- this.renderWindowInsets = this.getAdjustedRenderWindowSize(
87
- this.renderWindowInsets
88
- );
89
- }
90
-
91
- public updateProps(props: FlashListProps<T>): GridLayoutProviderWithProps<T> {
92
- const newInsetValues = applyContentContainerInsetForLayoutManager(
93
- {
94
- height: 0,
95
- width: 0,
96
- },
97
- props.contentContainerStyle,
98
- Boolean(props.horizontal)
99
- );
100
- this._hasExpired =
101
- this._hasExpired ||
102
- this.props.numColumns !== props.numColumns ||
103
- newInsetValues.height !== this.renderWindowInsets.height ||
104
- newInsetValues.width !== this.renderWindowInsets.width;
105
- this.renderWindowInsets = newInsetValues;
106
- this.props = props;
107
- return this;
108
- }
109
-
110
- /**
111
- * This methods returns true if the layout provider has expired and needs to be recreated.
112
- * This can happen if the number of columns has changed or the render window size has changed in a way that cannot be handled by the layout provider internally.
113
- */
114
- public get hasExpired() {
115
- return this._hasExpired;
116
- }
117
-
118
- /**
119
- * Calling this method will mark the layout provider as expired. As a result, a new one will be created by FlashList and old cached layouts will be discarded.
120
- */
121
- public markExpired() {
122
- this._hasExpired = true;
123
- }
124
-
125
- /**
126
- * Calling this method will help the layout provider track average item sizes on its own
127
- * Overriding layout manager can help achieve the same thing without relying on this method being called however, it will make implementation very complex for a simple use case
128
- * @param index Index of the item being reported
129
- */
130
- public reportItemLayout(index: number) {
131
- const layout = this.getLayoutManager()?.getLayouts()[index];
132
- if (layout) {
133
- // For the same index we can now return different estimates because average is updated in realtime
134
- // Marking the layout as overridden will help layout manager avoid using the average after initial measurement
135
- layout.isOverridden = true;
136
- this.averageWindow.addValue(
137
- this.props.horizontal ? layout.width : layout.height
138
- );
139
- }
140
- }
141
-
142
- public get averageItemSize() {
143
- return this.averageWindow.currentValue;
144
- }
145
-
146
- public newLayoutManager(
147
- renderWindowSize: Dimension,
148
- isHorizontal?: boolean,
149
- cachedLayouts?: Layout[]
150
- ): LayoutManager {
151
- // Average window is updated whenever a new layout manager is created. This is because old values are not relevant anymore.
152
- const estimatedItemCount = Math.max(
153
- 3,
154
- Math.round(
155
- (this.props.horizontal
156
- ? renderWindowSize.width
157
- : renderWindowSize.height) /
158
- (this.props.estimatedItemSize ?? this.defaultEstimatedItemSize)
159
- )
160
- );
161
- this.averageWindow = new AverageWindow(
162
- 2 * (this.props.numColumns || 1) * estimatedItemCount,
163
- this.averageWindow.currentValue
164
- );
165
- const newLayoutManager = super.newLayoutManager(
166
- this.getAdjustedRenderWindowSize(renderWindowSize),
167
- isHorizontal,
168
- cachedLayouts
169
- );
170
- if (cachedLayouts) {
171
- this.updateCachedDimensions(cachedLayouts, newLayoutManager);
172
- }
173
- return newLayoutManager;
174
- }
175
-
176
- private updateCachedDimensions(
177
- cachedLayouts: Layout[],
178
- layoutManager: LayoutManager
179
- ) {
180
- const layoutCount = cachedLayouts.length;
181
- for (let i = 0; i < layoutCount; i++) {
182
- cachedLayouts[i] = {
183
- ...cachedLayouts[i],
184
- // helps in updating the fixed dimension of layouts e.g, width in case of horizontal list
185
- // updating them in advance will make sure layout manager won't try to fit more items in the same row or column
186
- ...layoutManager.getStyleOverridesForIndex(i),
187
- };
188
- }
189
- }
190
-
191
- private getCleanLayoutObj() {
192
- this.layoutObject.size = undefined;
193
- this.layoutObject.span = undefined;
194
- return this.layoutObject;
195
- }
196
-
197
- private getAdjustedRenderWindowSize(renderWindowSize: Dimension) {
198
- return applyContentContainerInsetForLayoutManager(
199
- { ...renderWindowSize },
200
- this.props.contentContainerStyle,
201
- Boolean(this.props.horizontal)
202
- );
203
- }
204
- }
@@ -1,499 +0,0 @@
1
- /**
2
- * MIT License
3
- *
4
- * Copyright (C) 2024 Huawei Device Co., Ltd.
5
- *
6
- * Permission is hereby granted, free of charge, to any person obtaining a copy
7
- * of this software and associated documentation files (the "Software"), to deal
8
- * in the Software without restriction, including without limitation the rights
9
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
- * copies of the Software, and to permit persons to whom the Software is
11
- * furnished to do so, subject to the following conditions:
12
- *
13
- * The above copyright notice and this permission notice shall be included in all
14
- * copies or substantial portions of the Software.
15
- *
16
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
- * SOFTWARE.
23
- */
24
- import React, { useCallback, useRef, useEffect, useMemo } from "react";
25
- import {
26
- View,
27
- Dimensions,
28
- ScrollViewProps,
29
- LayoutChangeEvent,
30
- NativeScrollEvent,
31
- NativeSyntheticEvent,
32
- } from "react-native";
33
-
34
- import CustomError from "./errors/CustomError";
35
- import ExceptionList from "./errors/ExceptionList";
36
- import FlashList from "./FlashList";
37
- import { FlashListProps, ListRenderItemInfo } from "./FlashListProps";
38
- import { applyContentContainerInsetForLayoutManager } from "./utils/ContentContainerUtils";
39
- import ViewToken from "./viewability/ViewToken";
40
-
41
- export interface MasonryListRenderItemInfo<TItem>
42
- extends ListRenderItemInfo<TItem> {
43
- columnSpan: number;
44
- columnIndex: number;
45
- }
46
-
47
- export type MasonryListRenderItem<TItem> = (
48
- info: MasonryListRenderItemInfo<TItem>
49
- ) => React.ReactElement | null;
50
-
51
- export interface MasonryFlashListProps<T>
52
- extends Omit<
53
- FlashListProps<T>,
54
- | "horizontal"
55
- | "initialScrollIndex"
56
- | "inverted"
57
- | "onBlankArea"
58
- | "renderItem"
59
- | "viewabilityConfigCallbackPairs"
60
- > {
61
- /**
62
- * Allows you to change the column widths of the list. This is helpful if you want some columns to be wider than the others.
63
- * 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.
64
- */
65
- getColumnFlex?: (
66
- items: MasonryListItem<T>[],
67
- columnIndex: number,
68
- maxColumns: number,
69
- extraData?: any
70
- ) => number;
71
-
72
- /**
73
- * If enabled, MasonryFlashList will try to reduce difference in column height by modifying item order.
74
- * `overrideItemLayout` is required to make this work.
75
- */
76
- optimizeItemArrangement?: boolean;
77
-
78
- /**
79
- * Extends typical `renderItem` to include `columnIndex` and `columnSpan` (number of columns the item spans).
80
- * `columnIndex` gives the consumer column information in case they might need to treat items differently based on column.
81
- * This information may not otherwise be derived if using the `optimizeItemArrangement` feature, as the items will no
82
- * longer be linearly distributed across the columns; instead they are allocated to the column with the least estimated height.
83
- */
84
- renderItem: MasonryListRenderItem<T> | null | undefined;
85
- }
86
-
87
- type OnScrollCallback = ScrollViewProps["onScroll"];
88
- const defaultEstimatedItemSize = 100;
89
-
90
- export interface MasonryFlashListScrollEvent extends NativeScrollEvent {
91
- doNotPropagate?: boolean;
92
- }
93
-
94
- export interface MasonryListItem<T> {
95
- originalIndex: number;
96
- originalItem: T;
97
- }
98
-
99
- /**
100
- * MasonryFlashListRef with support for scroll related methods
101
- */
102
- export interface MasonryFlashListRef<T> {
103
- scrollToOffset: FlashList<T>["scrollToOffset"];
104
- scrollToEnd: FlashList<T>["scrollToEnd"];
105
- getScrollableNode: FlashList<T>["getScrollableNode"];
106
- }
107
-
108
- /**
109
- * FlashList variant that enables rendering of masonry layouts.
110
- * If you want `MasonryFlashList` to optimize item arrangement, enable `optimizeItemArrangement` and pass a valid `overrideItemLayout` function.
111
- */
112
- const MasonryFlashListComponent = React.forwardRef(
113
- <T,>(
114
- /**
115
- * Forward Ref will force cast generic parament T to unknown. Export has a explicit cast to solve this.
116
- */
117
- props: MasonryFlashListProps<T>,
118
- forwardRef: React.ForwardedRef<MasonryFlashListRef<T>>
119
- ) => {
120
- const columnCount = props.numColumns || 1;
121
- const drawDistance = props.drawDistance;
122
- const estimatedListSize = props.estimatedListSize ??
123
- Dimensions.get("window") ?? { height: 500, width: 500 };
124
-
125
- if (props.optimizeItemArrangement && !props.overrideItemLayout) {
126
- throw new CustomError(
127
- ExceptionList.overrideItemLayoutRequiredForMasonryOptimization
128
- );
129
- }
130
- const dataSet = useDataSet(
131
- columnCount,
132
- Boolean(props.optimizeItemArrangement),
133
- props.data,
134
- props.overrideItemLayout,
135
- props.extraData
136
- );
137
-
138
- const totalColumnFlex = useTotalColumnFlex(dataSet, props);
139
-
140
- const propsRef = useRef(props);
141
- propsRef.current = props;
142
-
143
- const onScrollRef = useRef<OnScrollCallback[]>([]);
144
- const emptyScrollEvent = useRef(getEmptyScrollEvent())
145
- .current as NativeSyntheticEvent<MasonryFlashListScrollEvent>;
146
- const ScrollComponent = useRef(
147
- getFlashListScrollView(onScrollRef, () => {
148
- return (
149
- getListRenderedSize(parentFlashList)?.height ||
150
- estimatedListSize.height
151
- );
152
- })
153
- ).current;
154
-
155
- const onScrollProxy = useRef<OnScrollCallback>(
156
- (scrollEvent: NativeSyntheticEvent<MasonryFlashListScrollEvent>) => {
157
- emptyScrollEvent.nativeEvent.contentOffset.y =
158
- scrollEvent.nativeEvent.contentOffset.y -
159
- (parentFlashList.current?.firstItemOffset ?? 0);
160
- onScrollRef.current?.forEach((onScrollCallback) => {
161
- onScrollCallback?.(emptyScrollEvent);
162
- });
163
- if (!scrollEvent.nativeEvent.doNotPropagate) {
164
- propsRef.current.onScroll?.(scrollEvent);
165
- }
166
- }
167
- ).current;
168
-
169
- /**
170
- * We're triggering an onScroll on internal lists so that they register the correct offset which is offset - header size.
171
- * This will make sure viewability callbacks are triggered correctly.
172
- * 32 ms is equal to two frames at 60 fps. Faster framerates will not cause any problems.
173
- */
174
- const onLoadForNestedLists = useRef((args: { elapsedTimeInMs: number }) => {
175
- setTimeout(() => {
176
- emptyScrollEvent.nativeEvent.doNotPropagate = true;
177
- onScrollProxy?.(emptyScrollEvent);
178
- emptyScrollEvent.nativeEvent.doNotPropagate = false;
179
- }, 32);
180
- propsRef.current.onLoad?.(args);
181
- }).current;
182
-
183
- const [parentFlashList, getFlashList] =
184
- useRefWithForwardRef<FlashList<MasonryListItem<T>[]>>(forwardRef);
185
-
186
- const {
187
- renderItem,
188
- getItemType,
189
- getColumnFlex,
190
- overrideItemLayout,
191
- viewabilityConfig,
192
- keyExtractor,
193
- onLoad,
194
- onViewableItemsChanged,
195
- data,
196
- stickyHeaderIndices,
197
- CellRendererComponent,
198
- ItemSeparatorComponent,
199
- ...remainingProps
200
- } = props;
201
-
202
- const firstColumnHeight =
203
- (dataSet[0]?.length ?? 0) *
204
- (props.estimatedItemSize ?? defaultEstimatedItemSize);
205
-
206
- const insetForLayoutManager = applyContentContainerInsetForLayoutManager(
207
- { height: 0, width: 0 },
208
- props.contentContainerStyle,
209
- false
210
- );
211
-
212
- return (
213
- <FlashList
214
- ref={getFlashList}
215
- {...remainingProps}
216
- horizontal={false}
217
- numColumns={columnCount}
218
- data={dataSet}
219
- onScroll={onScrollProxy}
220
- estimatedItemSize={firstColumnHeight || estimatedListSize.height}
221
- renderItem={(args) => {
222
- return (
223
- <FlashList
224
- renderScrollComponent={ScrollComponent}
225
- estimatedItemSize={props.estimatedItemSize}
226
- data={args.item}
227
- onLoad={args.index === 0 ? onLoadForNestedLists : undefined}
228
- renderItem={(innerArgs) => {
229
- return (
230
- renderItem?.({
231
- ...innerArgs,
232
- item: innerArgs.item.originalItem,
233
- index: innerArgs.item.originalIndex,
234
- columnSpan: 1,
235
- columnIndex: args.index,
236
- }) ?? null
237
- );
238
- }}
239
- keyExtractor={
240
- keyExtractor
241
- ? (item, _) => {
242
- return keyExtractor?.(
243
- item.originalItem,
244
- item.originalIndex
245
- );
246
- }
247
- : undefined
248
- }
249
- getItemType={
250
- getItemType
251
- ? (item, _, extraData) => {
252
- return getItemType?.(
253
- item.originalItem,
254
- item.originalIndex,
255
- extraData
256
- );
257
- }
258
- : undefined
259
- }
260
- drawDistance={drawDistance}
261
- estimatedListSize={{
262
- height: estimatedListSize.height,
263
- width:
264
- (((getListRenderedSize(parentFlashList)?.width ||
265
- estimatedListSize.width) +
266
- insetForLayoutManager.width) /
267
- totalColumnFlex) *
268
- (getColumnFlex?.(
269
- args.item,
270
- args.index,
271
- columnCount,
272
- props.extraData
273
- ) ?? 1),
274
- }}
275
- extraData={props.extraData}
276
- CellRendererComponent={CellRendererComponent}
277
- ItemSeparatorComponent={ItemSeparatorComponent}
278
- viewabilityConfig={viewabilityConfig}
279
- onViewableItemsChanged={
280
- onViewableItemsChanged
281
- ? (info) => {
282
- updateViewTokens(info.viewableItems);
283
- updateViewTokens(info.changed);
284
- onViewableItemsChanged?.(info);
285
- }
286
- : undefined
287
- }
288
- overrideItemLayout={
289
- overrideItemLayout
290
- ? (layout, item, _, __, extraData) => {
291
- overrideItemLayout?.(
292
- layout,
293
- item.originalItem,
294
- item.originalIndex,
295
- columnCount,
296
- extraData
297
- );
298
- layout.span = undefined;
299
- }
300
- : undefined
301
- }
302
- />
303
- );
304
- }}
305
- overrideItemLayout={
306
- getColumnFlex
307
- ? (layout, item, index, maxColumns, extraData) => {
308
- layout.span =
309
- (columnCount *
310
- getColumnFlex(item, index, maxColumns, extraData)) /
311
- totalColumnFlex;
312
- }
313
- : undefined
314
- }
315
- />
316
- );
317
- }
318
- );
319
-
320
- /**
321
- * Splits data for each column's FlashList
322
- */
323
- const useDataSet = <T,>(
324
- columnCount: number,
325
- optimizeItemArrangement: boolean,
326
- sourceData?: FlashListProps<T>["data"],
327
- overrideItemLayout?: MasonryFlashListProps<T>["overrideItemLayout"],
328
- extraData?: MasonryFlashListProps<T>["extraData"]
329
- ): MasonryListItem<T>[][] => {
330
- return useMemo(() => {
331
- if (!sourceData || sourceData.length === 0) {
332
- return [];
333
- }
334
- const columnHeightTracker = new Array<number>(columnCount).fill(0);
335
- const layoutObject: { size: number | undefined } = { size: undefined };
336
- const dataSet = new Array<MasonryListItem<T>[]>(columnCount);
337
- const dataSize = sourceData.length;
338
-
339
- for (let i = 0; i < columnCount; i++) {
340
- dataSet[i] = [];
341
- }
342
- for (let i = 0; i < dataSize; i++) {
343
- let nextColumnIndex = i % columnCount;
344
- if (optimizeItemArrangement) {
345
- for (let j = 0; j < columnCount; j++) {
346
- if (columnHeightTracker[j] < columnHeightTracker[nextColumnIndex]) {
347
- nextColumnIndex = j;
348
- }
349
- }
350
- // update height of column
351
- layoutObject.size = undefined;
352
- overrideItemLayout!(
353
- layoutObject,
354
- sourceData[i],
355
- i,
356
- columnCount,
357
- extraData
358
- );
359
- columnHeightTracker[nextColumnIndex] +=
360
- layoutObject.size ?? defaultEstimatedItemSize;
361
- }
362
- dataSet[nextColumnIndex].push({
363
- originalItem: sourceData[i],
364
- originalIndex: i,
365
- });
366
- }
367
- return dataSet;
368
- // eslint-disable-next-line react-hooks/exhaustive-deps
369
- }, [sourceData, columnCount, optimizeItemArrangement, extraData]);
370
- };
371
-
372
- const useTotalColumnFlex = <T,>(
373
- dataSet: MasonryListItem<T>[][],
374
- props: MasonryFlashListProps<T>
375
- ): number => {
376
- return useMemo(() => {
377
- const columnCount = props.numColumns || 1;
378
- if (!props.getColumnFlex) {
379
- return columnCount;
380
- }
381
- let totalFlexSum = 0;
382
- const dataSize = dataSet.length;
383
- for (let i = 0; i < dataSize; i++) {
384
- totalFlexSum += props.getColumnFlex(
385
- dataSet[i],
386
- i,
387
- columnCount,
388
- props.extraData
389
- );
390
- }
391
- return totalFlexSum;
392
- // eslint-disable-next-line react-hooks/exhaustive-deps
393
- }, [dataSet, props.getColumnFlex, props.extraData]);
394
- };
395
-
396
- /**
397
- * Handle both function refs and refs with current property
398
- */
399
- const useRefWithForwardRef = <T,>(
400
- forwardRef: any
401
- ): [React.MutableRefObject<T | null>, (instance: T | null) => void] => {
402
- const ref: React.MutableRefObject<T | null> = useRef(null);
403
- return [
404
- ref,
405
- useCallback(
406
- (instance: T | null) => {
407
- ref.current = instance;
408
- if (typeof forwardRef === "function") {
409
- forwardRef(instance);
410
- } else if (forwardRef) {
411
- forwardRef.current = instance;
412
- }
413
- },
414
- [forwardRef]
415
- ),
416
- ];
417
- };
418
-
419
- /**
420
- * This ScrollView is actually just a view mimicking a scrollview. We block the onScroll event from being passed to the parent list directly.
421
- * We manually drive onScroll from the parent and thus, achieve recycling.
422
- */
423
- const getFlashListScrollView = (
424
- onScrollRef: React.RefObject<OnScrollCallback[]>,
425
- getParentHeight: () => number
426
- ) => {
427
- const FlashListScrollView = React.forwardRef(
428
- (props: ScrollViewProps, ref: React.ForwardedRef<View>) => {
429
- const { onLayout, onScroll, ...rest } = props;
430
- const onLayoutProxy = useCallback(
431
- (layoutEvent: LayoutChangeEvent) => {
432
- onLayout?.({
433
- nativeEvent: {
434
- layout: {
435
- height: getParentHeight(),
436
- width: layoutEvent.nativeEvent.layout.width,
437
- },
438
- },
439
- } as LayoutChangeEvent);
440
- },
441
- [onLayout]
442
- );
443
- useEffect(() => {
444
- if (onScroll) {
445
- onScrollRef.current?.push(onScroll);
446
- }
447
- return () => {
448
- if (!onScrollRef.current || !onScroll) {
449
- return;
450
- }
451
- const indexToDelete = onScrollRef.current.indexOf(onScroll);
452
- if (indexToDelete > -1) {
453
- onScrollRef.current.splice(indexToDelete, 1);
454
- }
455
- };
456
- }, [onScroll]);
457
- return <View ref={ref} {...rest} onLayout={onLayoutProxy} />;
458
- }
459
- );
460
- FlashListScrollView.displayName = "FlashListScrollView";
461
- return FlashListScrollView;
462
- };
463
- const updateViewTokens = (tokens: ViewToken[]) => {
464
- const length = tokens.length;
465
- for (let i = 0; i < length; i++) {
466
- const token = tokens[i];
467
- if (token.index !== null && token.index !== undefined) {
468
- if (token.item) {
469
- token.index = token.item.originalIndex;
470
- token.item = token.item.originalItem;
471
- } else {
472
- token.index = null;
473
- token.item = undefined;
474
- }
475
- }
476
- }
477
- };
478
-
479
- const getEmptyScrollEvent = () => {
480
- return {
481
- nativeEvent: { contentOffset: { y: 0, x: 0 } },
482
- };
483
- };
484
- const getListRenderedSize = <T,>(
485
- parentFlashList: React.MutableRefObject<FlashList<T[]> | null>
486
- ) => {
487
- return parentFlashList?.current?.recyclerlistview_unsafe?.getRenderedSize();
488
- };
489
- MasonryFlashListComponent.displayName = "MasonryFlashList";
490
-
491
- /**
492
- * FlashList variant that enables rendering of masonry layouts.
493
- * If you want `MasonryFlashList` to optimize item arrangement, enable `optimizeItemArrangement` and pass a valid `overrideItemLayout` function.
494
- */
495
- export const MasonryFlashList = MasonryFlashListComponent as <T>(
496
- props: MasonryFlashListProps<T> & {
497
- ref?: React.RefObject<MasonryFlashListRef<T>>;
498
- }
499
- ) => React.ReactElement;