@react-native-ohos/flash-list 1.8.3-rc.2 → 1.8.3-rc.4

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 (206) hide show
  1. package/LICENSE +6 -6
  2. package/README.OpenSource +10 -10
  3. package/README.md +9 -9
  4. package/dist/AnimatedFlashList.d.ts +28 -25
  5. package/dist/AnimatedFlashList.d.ts.map +1 -1
  6. package/dist/AnimatedFlashList.js +30 -30
  7. package/dist/FlashList.d.ts +179 -179
  8. package/dist/FlashList.d.ts.map +1 -1
  9. package/dist/FlashList.js +599 -598
  10. package/dist/FlashList.js.map +1 -1
  11. package/dist/FlashListProps.d.ts +278 -278
  12. package/dist/FlashListProps.js +31 -31
  13. package/dist/GridLayoutProviderWithProps.d.ts +64 -64
  14. package/dist/GridLayoutProviderWithProps.js +137 -136
  15. package/dist/GridLayoutProviderWithProps.js.map +1 -1
  16. package/dist/MasonryFlashList.d.ts +73 -73
  17. package/dist/MasonryFlashList.d.ts.map +1 -1
  18. package/dist/MasonryFlashList.js +274 -274
  19. package/dist/MasonryFlashList.js.map +1 -1
  20. package/dist/PureComponentWrapper.d.ts +44 -44
  21. package/dist/PureComponentWrapper.js +59 -59
  22. package/dist/PureComponentWrapper.js.map +1 -1
  23. package/dist/benchmark/AutoScrollHelper.d.ts +40 -40
  24. package/dist/benchmark/AutoScrollHelper.js +90 -90
  25. package/dist/benchmark/AutoScrollHelper.js.map +1 -1
  26. package/dist/benchmark/JSFPSMonitor.d.ts +45 -45
  27. package/dist/benchmark/JSFPSMonitor.js +87 -87
  28. package/dist/benchmark/JSFPSMonitor.js.map +1 -1
  29. package/dist/benchmark/roundToDecimalPlaces.d.ts +24 -24
  30. package/dist/benchmark/roundToDecimalPlaces.js +31 -30
  31. package/dist/benchmark/roundToDecimalPlaces.js.map +1 -1
  32. package/dist/benchmark/useBenchmark.d.ts +57 -57
  33. package/dist/benchmark/useBenchmark.js +189 -188
  34. package/dist/benchmark/useBenchmark.js.map +1 -1
  35. package/dist/benchmark/useBlankAreaTracker.d.ts +56 -56
  36. package/dist/benchmark/useBlankAreaTracker.js +89 -88
  37. package/dist/benchmark/useBlankAreaTracker.js.map +1 -1
  38. package/dist/benchmark/useDataMultiplier.d.ts +31 -31
  39. package/dist/benchmark/useDataMultiplier.js +47 -46
  40. package/dist/benchmark/useDataMultiplier.js.map +1 -1
  41. package/dist/benchmark/useFlatListBenchmark.d.ts +35 -34
  42. package/dist/benchmark/useFlatListBenchmark.d.ts.map +1 -1
  43. package/dist/benchmark/useFlatListBenchmark.js +122 -121
  44. package/dist/benchmark/useFlatListBenchmark.js.map +1 -1
  45. package/dist/errors/CustomError.d.ts +30 -30
  46. package/dist/errors/CustomError.js +36 -36
  47. package/dist/errors/CustomError.js.map +1 -1
  48. package/dist/errors/ExceptionList.d.ts +46 -46
  49. package/dist/errors/ExceptionList.js +48 -48
  50. package/dist/errors/Warnings.d.ts +31 -31
  51. package/dist/errors/Warnings.js +35 -35
  52. package/dist/fabric/AutoLayoutNativeComponent.d.ts +41 -41
  53. package/dist/fabric/AutoLayoutNativeComponent.d.ts.map +1 -1
  54. package/dist/fabric/AutoLayoutNativeComponent.js +28 -28
  55. package/dist/fabric/CellContainerNativeComponent.d.ts +30 -30
  56. package/dist/fabric/CellContainerNativeComponent.d.ts.map +1 -1
  57. package/dist/fabric/CellContainerNativeComponent.js +28 -28
  58. package/dist/index.d.ts +36 -36
  59. package/dist/index.js +54 -52
  60. package/dist/index.js.map +1 -1
  61. package/dist/native/auto-layout/AutoLayoutView.d.ts +44 -44
  62. package/dist/native/auto-layout/AutoLayoutView.d.ts.map +1 -1
  63. package/dist/native/auto-layout/AutoLayoutView.js +70 -70
  64. package/dist/native/auto-layout/AutoLayoutView.js.map +1 -1
  65. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.d.ts +26 -25
  66. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.d.ts.map +1 -1
  67. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.js +28 -28
  68. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.d.ts +27 -27
  69. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.d.ts.map +1 -1
  70. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.d.ts +26 -25
  71. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.d.ts.map +1 -1
  72. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.js +28 -28
  73. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.d.ts +26 -25
  74. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.d.ts.map +1 -1
  75. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.js +28 -28
  76. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.js +28 -28
  77. package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.d.ts +38 -38
  78. package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.js +25 -25
  79. package/dist/native/cell-container/CellContainer.android.d.ts +28 -28
  80. package/dist/native/cell-container/CellContainer.android.d.ts.map +1 -1
  81. package/dist/native/cell-container/CellContainer.android.js +31 -31
  82. package/dist/native/cell-container/CellContainer.d.ts +30 -29
  83. package/dist/native/cell-container/CellContainer.d.ts.map +1 -1
  84. package/dist/native/cell-container/CellContainer.harmony.d.ts +28 -28
  85. package/dist/native/cell-container/CellContainer.harmony.d.ts.map +1 -1
  86. package/dist/native/cell-container/CellContainer.harmony.js +31 -31
  87. package/dist/native/cell-container/CellContainer.ios.d.ts +28 -28
  88. package/dist/native/cell-container/CellContainer.ios.d.ts.map +1 -1
  89. package/dist/native/cell-container/CellContainer.ios.js +31 -31
  90. package/dist/native/cell-container/CellContainer.js +33 -33
  91. package/dist/native/cell-container/CellContainer.web.d.ts +29 -28
  92. package/dist/native/cell-container/CellContainer.web.d.ts.map +1 -1
  93. package/dist/native/cell-container/CellContainer.web.js +35 -35
  94. package/dist/native/config/PlatformHelper.android.d.ts +48 -48
  95. package/dist/native/config/PlatformHelper.android.d.ts.map +1 -1
  96. package/dist/native/config/PlatformHelper.android.js +45 -45
  97. package/dist/native/config/PlatformHelper.d.ts +48 -48
  98. package/dist/native/config/PlatformHelper.d.ts.map +1 -1
  99. package/dist/native/config/PlatformHelper.harmony.d.ts +48 -48
  100. package/dist/native/config/PlatformHelper.harmony.d.ts.map +1 -1
  101. package/dist/native/config/PlatformHelper.harmony.js +44 -44
  102. package/dist/native/config/PlatformHelper.ios.d.ts +48 -48
  103. package/dist/native/config/PlatformHelper.ios.d.ts.map +1 -1
  104. package/dist/native/config/PlatformHelper.ios.js +44 -44
  105. package/dist/native/config/PlatformHelper.js +45 -45
  106. package/dist/native/config/PlatformHelper.web.d.ts +49 -49
  107. package/dist/native/config/PlatformHelper.web.d.ts.map +1 -1
  108. package/dist/native/config/PlatformHelper.web.js +47 -47
  109. package/dist/tsconfig.tsbuildinfo +1 -1
  110. package/dist/utils/AverageWindow.d.ts +43 -43
  111. package/dist/utils/AverageWindow.js +71 -71
  112. package/dist/utils/ContentContainerUtils.d.ts +49 -49
  113. package/dist/utils/ContentContainerUtils.d.ts.map +1 -1
  114. package/dist/utils/ContentContainerUtils.js +70 -70
  115. package/dist/utils/ContentContainerUtils.js.map +1 -1
  116. package/dist/viewability/ViewToken.d.ts +30 -30
  117. package/dist/viewability/ViewToken.js +25 -25
  118. package/dist/viewability/ViewabilityHelper.d.ts +48 -48
  119. package/dist/viewability/ViewabilityHelper.js +129 -129
  120. package/dist/viewability/ViewabilityHelper.js.map +1 -1
  121. package/dist/viewability/ViewabilityManager.d.ts +47 -47
  122. package/dist/viewability/ViewabilityManager.d.ts.map +1 -1
  123. package/dist/viewability/ViewabilityManager.js +130 -130
  124. package/dist/viewability/ViewabilityManager.js.map +1 -1
  125. package/harmony/flash_list/BuildProfile.ets +16 -16
  126. package/harmony/flash_list/LICENSE +7 -7
  127. package/harmony/flash_list/build-profile.json5 +7 -7
  128. package/harmony/flash_list/hvigorfile.ts +1 -1
  129. package/harmony/flash_list/index.ets +27 -27
  130. package/harmony/flash_list/obfuscation-rules.txt +17 -17
  131. package/harmony/flash_list/oh-package.json5 +23 -23
  132. package/harmony/flash_list/src/main/cpp/AutoLayoutNode.cpp +63 -140
  133. package/harmony/flash_list/src/main/cpp/AutoLayoutNode.h +53 -53
  134. package/harmony/flash_list/src/main/cpp/AutoLayoutShadow.cpp +31 -24
  135. package/harmony/flash_list/src/main/cpp/AutoLayoutShadow.h +66 -66
  136. package/harmony/flash_list/src/main/cpp/AutoLayoutViewComponentInstance.cpp +208 -208
  137. package/harmony/flash_list/src/main/cpp/AutoLayoutViewComponentInstance.h +78 -78
  138. package/harmony/flash_list/src/main/cpp/AutoLayoutViewEventEmitRequestHandler.h +53 -53
  139. package/harmony/flash_list/src/main/cpp/AutoLayoutViewJSIBinder.h +50 -50
  140. package/harmony/flash_list/src/main/cpp/CMakeLists.txt +6 -6
  141. package/harmony/flash_list/src/main/cpp/CellContainerComponentInstance.cpp +79 -79
  142. package/harmony/flash_list/src/main/cpp/CellContainerComponentInstance.h +63 -63
  143. package/harmony/flash_list/src/main/cpp/CellContainerJSIBinder.h +38 -38
  144. package/harmony/flash_list/src/main/cpp/ComponentDescriptors.h +40 -40
  145. package/harmony/flash_list/src/main/cpp/EventEmitters.cpp +39 -39
  146. package/harmony/flash_list/src/main/cpp/EventEmitters.h +48 -48
  147. package/harmony/flash_list/src/main/cpp/FlashListPackage.h +77 -77
  148. package/harmony/flash_list/src/main/cpp/FlashListStackNode.cpp +87 -87
  149. package/harmony/flash_list/src/main/cpp/FlashListStackNode.h +56 -56
  150. package/harmony/flash_list/src/main/cpp/Props.cpp +51 -51
  151. package/harmony/flash_list/src/main/cpp/Props.h +64 -64
  152. package/harmony/flash_list/src/main/cpp/ShadowNodes.cpp +33 -33
  153. package/harmony/flash_list/src/main/cpp/ShadowNodes.h +48 -48
  154. package/harmony/flash_list/src/main/ets/Logger.ets +63 -63
  155. package/harmony/flash_list/src/main/ets/RNAutoLayoutShadow.ets +153 -153
  156. package/harmony/flash_list/src/main/ets/RNAutoLayoutView.ets +276 -276
  157. package/harmony/flash_list/src/main/ets/RNCellContainer.ets +113 -113
  158. package/harmony/flash_list/src/main/module.json5 +9 -9
  159. package/harmony/flash_list/src/main/resources/base/element/color.json +7 -7
  160. package/harmony/flash_list/src/main/resources/base/element/string.json +15 -15
  161. package/harmony/flash_list/src/main/resources/base/profile/main_pages.json +5 -5
  162. package/harmony/flash_list/src/main/resources/en_US/element/string.json +15 -15
  163. package/harmony/flash_list/src/main/resources/zh_CN/element/string.json +15 -15
  164. package/harmony/flash_list.har +0 -0
  165. package/jestSetup.js +40 -40
  166. package/package.json +82 -82
  167. package/src/AnimatedFlashList.ts +35 -35
  168. package/src/FlashList.tsx +949 -949
  169. package/src/FlashListProps.ts +359 -359
  170. package/src/GridLayoutProviderWithProps.ts +204 -204
  171. package/src/MasonryFlashList.tsx +499 -499
  172. package/src/PureComponentWrapper.tsx +65 -65
  173. package/src/benchmark/AutoScrollHelper.ts +94 -94
  174. package/src/benchmark/JSFPSMonitor.ts +98 -98
  175. package/src/benchmark/roundToDecimalPlaces.ts +28 -28
  176. package/src/benchmark/useBenchmark.ts +264 -264
  177. package/src/benchmark/useBlankAreaTracker.ts +141 -141
  178. package/src/benchmark/useDataMultiplier.ts +43 -43
  179. package/src/benchmark/useFlatListBenchmark.ts +131 -131
  180. package/src/errors/CustomError.ts +34 -34
  181. package/src/errors/ExceptionList.ts +52 -52
  182. package/src/errors/Warnings.ts +39 -39
  183. package/src/fabric/AutoLayoutNativeComponent.ts +52 -52
  184. package/src/fabric/CellContainerNativeComponent.ts +35 -35
  185. package/src/index.ts +67 -67
  186. package/src/native/auto-layout/AutoLayoutView.tsx +97 -97
  187. package/src/native/auto-layout/AutoLayoutViewNativeComponent.android.ts +31 -31
  188. package/src/native/auto-layout/AutoLayoutViewNativeComponent.harmony.ts +31 -31
  189. package/src/native/auto-layout/AutoLayoutViewNativeComponent.ios.ts +31 -31
  190. package/src/native/auto-layout/AutoLayoutViewNativeComponent.ts +31 -31
  191. package/src/native/auto-layout/AutoLayoutViewNativeComponentProps.ts +41 -41
  192. package/src/native/cell-container/CellContainer.android.ts +31 -31
  193. package/src/native/cell-container/CellContainer.harmony.ts +31 -31
  194. package/src/native/cell-container/CellContainer.ios.ts +31 -31
  195. package/src/native/cell-container/CellContainer.tsx +38 -38
  196. package/src/native/cell-container/CellContainer.web.tsx +33 -33
  197. package/src/native/config/PlatformHelper.android.ts +53 -53
  198. package/src/native/config/PlatformHelper.harmony.ts +52 -52
  199. package/src/native/config/PlatformHelper.ios.ts +52 -52
  200. package/src/native/config/PlatformHelper.ts +53 -53
  201. package/src/native/config/PlatformHelper.web.ts +58 -58
  202. package/src/utils/AverageWindow.ts +73 -73
  203. package/src/utils/ContentContainerUtils.ts +116 -116
  204. package/src/viewability/ViewToken.ts +31 -31
  205. package/src/viewability/ViewabilityHelper.ts +190 -190
  206. package/src/viewability/ViewabilityManager.ts +169 -169
@@ -1,141 +1,141 @@
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 React, { useCallback, useRef } from "react";
26
- import { RecyclerListView, RecyclerListViewProps } from "recyclerlistview";
27
-
28
- import { BlankAreaEvent } from "../native/auto-layout/AutoLayoutView";
29
- import FlashList from "../FlashList";
30
-
31
- export interface BlankAreaTrackerResult {
32
- /**
33
- * Max blank area displayed
34
- */
35
- maxBlankArea: number;
36
- /**
37
- * Sum of all blank area values across all frames
38
- */
39
- cumulativeBlankArea: number;
40
- }
41
- export interface BlankAreaTrackerConfig {
42
- /**
43
- * When set to true the hook will also sum all negative blank area values.
44
- * Blank area is negative when list is able to draw faster than the scroll speed.
45
- */
46
- sumNegativeValues?: boolean;
47
- /**
48
- * By default, the hook ignores blank events for 1s after the list load. This value can be changed using this parameter.
49
- * Please note that this duration kicks in after the list has loaded and not after the first scroll.
50
- */
51
- startDelayInMs?: number;
52
- }
53
-
54
- /**
55
- * Can be used to track visible blank area in production
56
- * @param flashListRef Ref to the FlashList component
57
- * @param onBlankAreaChange This event handler will be called when the blank area changes
58
- * @param config additional configuration for the blank area tracker
59
- * @returns blankAreaTrackerResult - maxBlankArea, cumulativeBlankArea this object is mutated and kept up to date. Also returns a callback that needs to be forwarded to FlashList.
60
- */
61
- export function useBlankAreaTracker(
62
- flashListRef: React.RefObject<FlashList<any>>,
63
- onBlankAreaChange?: (value: BlankAreaTrackerResult) => void,
64
- config?: BlankAreaTrackerConfig
65
- ): [BlankAreaTrackerResult, (event: BlankAreaEvent) => void] {
66
- const startDelay = config?.startDelayInMs ?? 1000;
67
- const blankAreaResult = useRef({
68
- maxBlankArea: 0,
69
- cumulativeBlankArea: 0,
70
- }).current;
71
- const waitOperations = useRef({ inProgress: false, complete: false }).current;
72
- const onBlankAreaChangeRef = useRef(onBlankAreaChange);
73
- onBlankAreaChangeRef.current = onBlankAreaChange;
74
-
75
- const blankAreaTracker = useCallback(
76
- (event: BlankAreaEvent) => {
77
- // we're ignoring some of the events that will be fired on list load
78
- // initial events are fired on mount and thus, this won't lead to missing events during scroll
79
- if (!waitOperations.complete && startDelay > 0) {
80
- if (!waitOperations.inProgress) {
81
- waitOperations.inProgress = true;
82
- setTimeout(() => {
83
- waitOperations.complete = true;
84
- }, startDelay);
85
- }
86
- return;
87
- }
88
- const rlv = flashListRef.current?.recyclerlistview_unsafe;
89
- const horizontal = Boolean(flashListRef.current?.props.horizontal);
90
- if (rlv) {
91
- processBlankAreaChange(
92
- rlv,
93
- horizontal,
94
- blankAreaResult,
95
- event,
96
- onBlankAreaChangeRef.current,
97
- config
98
- );
99
- }
100
- },
101
- // eslint-disable-next-line react-hooks/exhaustive-deps
102
- [flashListRef]
103
- );
104
- return [blankAreaResult, blankAreaTracker];
105
- }
106
-
107
- function processBlankAreaChange(
108
- rlv: RecyclerListView<RecyclerListViewProps, any>,
109
- horizontal: boolean,
110
- blankAreaResult: BlankAreaTrackerResult,
111
- event: BlankAreaEvent,
112
- onBlankAreaChange?: (value: BlankAreaTrackerResult) => void,
113
- config?: BlankAreaTrackerConfig
114
- ) {
115
- const listSize = horizontal
116
- ? rlv.getRenderedSize().width
117
- : rlv.getRenderedSize().height;
118
- const contentSize = horizontal
119
- ? rlv.getContentDimension().width
120
- : rlv.getContentDimension().height;
121
-
122
- // ignores blank events when there isn't enough content to fill the list
123
- if (contentSize > listSize) {
124
- const lastMaxBlankArea = blankAreaResult.maxBlankArea;
125
- const lastCumulativeBlankArea = blankAreaResult.cumulativeBlankArea;
126
- blankAreaResult.maxBlankArea = Math.max(
127
- blankAreaResult.maxBlankArea,
128
- event.blankArea,
129
- 0
130
- );
131
- blankAreaResult.cumulativeBlankArea += config?.sumNegativeValues
132
- ? event.blankArea
133
- : Math.max(event.blankArea, 0);
134
- if (
135
- lastCumulativeBlankArea !== blankAreaResult.cumulativeBlankArea ||
136
- lastMaxBlankArea !== blankAreaResult.maxBlankArea
137
- ) {
138
- onBlankAreaChange?.(blankAreaResult);
139
- }
140
- }
141
- }
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 React, { useCallback, useRef } from "react";
26
+ import { RecyclerListView, RecyclerListViewProps } from "recyclerlistview";
27
+
28
+ import { BlankAreaEvent } from "../native/auto-layout/AutoLayoutView";
29
+ import FlashList from "../FlashList";
30
+
31
+ export interface BlankAreaTrackerResult {
32
+ /**
33
+ * Max blank area displayed
34
+ */
35
+ maxBlankArea: number;
36
+ /**
37
+ * Sum of all blank area values across all frames
38
+ */
39
+ cumulativeBlankArea: number;
40
+ }
41
+ export interface BlankAreaTrackerConfig {
42
+ /**
43
+ * When set to true the hook will also sum all negative blank area values.
44
+ * Blank area is negative when list is able to draw faster than the scroll speed.
45
+ */
46
+ sumNegativeValues?: boolean;
47
+ /**
48
+ * By default, the hook ignores blank events for 1s after the list load. This value can be changed using this parameter.
49
+ * Please note that this duration kicks in after the list has loaded and not after the first scroll.
50
+ */
51
+ startDelayInMs?: number;
52
+ }
53
+
54
+ /**
55
+ * Can be used to track visible blank area in production
56
+ * @param flashListRef Ref to the FlashList component
57
+ * @param onBlankAreaChange This event handler will be called when the blank area changes
58
+ * @param config additional configuration for the blank area tracker
59
+ * @returns blankAreaTrackerResult - maxBlankArea, cumulativeBlankArea this object is mutated and kept up to date. Also returns a callback that needs to be forwarded to FlashList.
60
+ */
61
+ export function useBlankAreaTracker(
62
+ flashListRef: React.RefObject<FlashList<any>>,
63
+ onBlankAreaChange?: (value: BlankAreaTrackerResult) => void,
64
+ config?: BlankAreaTrackerConfig
65
+ ): [BlankAreaTrackerResult, (event: BlankAreaEvent) => void] {
66
+ const startDelay = config?.startDelayInMs ?? 1000;
67
+ const blankAreaResult = useRef({
68
+ maxBlankArea: 0,
69
+ cumulativeBlankArea: 0,
70
+ }).current;
71
+ const waitOperations = useRef({ inProgress: false, complete: false }).current;
72
+ const onBlankAreaChangeRef = useRef(onBlankAreaChange);
73
+ onBlankAreaChangeRef.current = onBlankAreaChange;
74
+
75
+ const blankAreaTracker = useCallback(
76
+ (event: BlankAreaEvent) => {
77
+ // we're ignoring some of the events that will be fired on list load
78
+ // initial events are fired on mount and thus, this won't lead to missing events during scroll
79
+ if (!waitOperations.complete && startDelay > 0) {
80
+ if (!waitOperations.inProgress) {
81
+ waitOperations.inProgress = true;
82
+ setTimeout(() => {
83
+ waitOperations.complete = true;
84
+ }, startDelay);
85
+ }
86
+ return;
87
+ }
88
+ const rlv = flashListRef.current?.recyclerlistview_unsafe;
89
+ const horizontal = Boolean(flashListRef.current?.props.horizontal);
90
+ if (rlv) {
91
+ processBlankAreaChange(
92
+ rlv,
93
+ horizontal,
94
+ blankAreaResult,
95
+ event,
96
+ onBlankAreaChangeRef.current,
97
+ config
98
+ );
99
+ }
100
+ },
101
+ // eslint-disable-next-line react-hooks/exhaustive-deps
102
+ [flashListRef]
103
+ );
104
+ return [blankAreaResult, blankAreaTracker];
105
+ }
106
+
107
+ function processBlankAreaChange(
108
+ rlv: RecyclerListView<RecyclerListViewProps, any>,
109
+ horizontal: boolean,
110
+ blankAreaResult: BlankAreaTrackerResult,
111
+ event: BlankAreaEvent,
112
+ onBlankAreaChange?: (value: BlankAreaTrackerResult) => void,
113
+ config?: BlankAreaTrackerConfig
114
+ ) {
115
+ const listSize = horizontal
116
+ ? rlv.getRenderedSize().width
117
+ : rlv.getRenderedSize().height;
118
+ const contentSize = horizontal
119
+ ? rlv.getContentDimension().width
120
+ : rlv.getContentDimension().height;
121
+
122
+ // ignores blank events when there isn't enough content to fill the list
123
+ if (contentSize > listSize) {
124
+ const lastMaxBlankArea = blankAreaResult.maxBlankArea;
125
+ const lastCumulativeBlankArea = blankAreaResult.cumulativeBlankArea;
126
+ blankAreaResult.maxBlankArea = Math.max(
127
+ blankAreaResult.maxBlankArea,
128
+ event.blankArea,
129
+ 0
130
+ );
131
+ blankAreaResult.cumulativeBlankArea += config?.sumNegativeValues
132
+ ? event.blankArea
133
+ : Math.max(event.blankArea, 0);
134
+ if (
135
+ lastCumulativeBlankArea !== blankAreaResult.cumulativeBlankArea ||
136
+ lastMaxBlankArea !== blankAreaResult.maxBlankArea
137
+ ) {
138
+ onBlankAreaChange?.(blankAreaResult);
139
+ }
140
+ }
141
+ }
@@ -1,43 +1,43 @@
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
- /**
26
- * Increases the data size by duplicating it, it's kept in hook format so that in future we can add auto pagination support.
27
- * If you're using this with FlatList then make sure you remove `keyExtractor` because this method might duplicate ids that might be in the data.
28
- * @param data The data to duplicate
29
- * @param count Final count of data to be returned from this hook
30
- * @returns Multiplied data.
31
- */
32
- export function useDataMultiplier<T>(data: T[], count: number): [T[]] {
33
- const len = data.length;
34
- const arr = new Array<T>(count);
35
- let isObject = false;
36
- if (typeof data[0] === "object") {
37
- isObject = true;
38
- }
39
- for (let i = 0; i < count; i++) {
40
- arr[i] = isObject ? { ...data[i % len] } : data[i % len];
41
- }
42
- return [arr];
43
- }
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
+ /**
26
+ * Increases the data size by duplicating it, it's kept in hook format so that in future we can add auto pagination support.
27
+ * If you're using this with FlatList then make sure you remove `keyExtractor` because this method might duplicate ids that might be in the data.
28
+ * @param data The data to duplicate
29
+ * @param count Final count of data to be returned from this hook
30
+ * @returns Multiplied data.
31
+ */
32
+ export function useDataMultiplier<T>(data: T[], count: number): [T[]] {
33
+ const len = data.length;
34
+ const arr = new Array<T>(count);
35
+ let isObject = false;
36
+ if (typeof data[0] === "object") {
37
+ isObject = true;
38
+ }
39
+ for (let i = 0; i < count; i++) {
40
+ arr[i] = isObject ? { ...data[i % len] } : data[i % len];
41
+ }
42
+ return [arr];
43
+ }
@@ -1,131 +1,131 @@
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 { useEffect } from "react";
26
- import { FlatList } from "react-native";
27
-
28
- import { autoScroll, Cancellable } from "./AutoScrollHelper";
29
- import { JSFPSMonitor } from "./JSFPSMonitor";
30
- import {
31
- BenchmarkParams,
32
- BenchmarkResult,
33
- getFormattedString,
34
- } from "./useBenchmark";
35
-
36
- export interface FlatListBenchmarkParams extends BenchmarkParams {
37
- targetOffset: number;
38
- }
39
-
40
- /**
41
- * Runs the benchmark on FlatList and calls the callback method with the result.
42
- * Target offset is mandatory in params.
43
- * It's recommended to remove pagination while running the benchmark. Removing the onEndReached callback is the easiest way to do that.
44
- */
45
- export function useFlatListBenchmark(
46
- flatListRef: React.RefObject<FlatList<any>>,
47
- callback: (benchmarkResult: BenchmarkResult) => void,
48
- params: FlatListBenchmarkParams
49
- ) {
50
- useEffect(() => {
51
- const cancellable = new Cancellable();
52
- if (flatListRef.current) {
53
- if (!(Number(flatListRef.current.props.data?.length) > 0)) {
54
- throw new Error("Data is empty, cannot run benchmark");
55
- }
56
- }
57
- const cancelTimeout = setTimeout(async () => {
58
- const jsFPSMonitor = new JSFPSMonitor();
59
- jsFPSMonitor.startTracking();
60
- for (let i = 0; i < (params.repeatCount || 1); i++) {
61
- await runScrollBenchmark(
62
- flatListRef,
63
- params.targetOffset,
64
- cancellable,
65
- params.speedMultiplier || 1
66
- );
67
- }
68
- const jsProfilerResponse = jsFPSMonitor.stopAndGetData();
69
- const result: BenchmarkResult = {
70
- js: jsProfilerResponse,
71
- suggestions: [],
72
- interrupted: cancellable.isCancelled(),
73
- };
74
- if (!cancellable.isCancelled()) {
75
- result.formattedString = getFormattedString(result);
76
- }
77
- callback(result);
78
- }, params.startDelayInMs || 3000);
79
- return () => {
80
- clearTimeout(cancelTimeout);
81
- cancellable.cancel();
82
- };
83
- // eslint-disable-next-line react-hooks/exhaustive-deps
84
- }, []);
85
- return [];
86
- }
87
-
88
- /**
89
- * Scrolls to the target offset and then back to 0
90
- */
91
- async function runScrollBenchmark(
92
- flatListRef: React.RefObject<FlatList<any> | null | undefined>,
93
- targetOffset: number,
94
- cancellable: Cancellable,
95
- scrollSpeedMultiplier: number
96
- ): Promise<void> {
97
- if (flatListRef.current) {
98
- const horizontal = flatListRef.current.props.horizontal;
99
-
100
- const fromX = 0;
101
- const fromY = 0;
102
- const toX = horizontal ? targetOffset : 0;
103
- const toY = horizontal ? 0 : targetOffset;
104
-
105
- const scrollNow = (x: number, y: number) => {
106
- flatListRef.current?.scrollToOffset({
107
- offset: horizontal ? x : y,
108
- animated: false,
109
- });
110
- };
111
-
112
- await autoScroll(
113
- scrollNow,
114
- fromX,
115
- fromY,
116
- toX,
117
- toY,
118
- scrollSpeedMultiplier,
119
- cancellable
120
- );
121
- await autoScroll(
122
- scrollNow,
123
- toX,
124
- toY,
125
- fromX,
126
- fromY,
127
- scrollSpeedMultiplier,
128
- cancellable
129
- );
130
- }
131
- }
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 { useEffect } from "react";
26
+ import { FlatList } from "react-native";
27
+
28
+ import { autoScroll, Cancellable } from "./AutoScrollHelper";
29
+ import { JSFPSMonitor } from "./JSFPSMonitor";
30
+ import {
31
+ BenchmarkParams,
32
+ BenchmarkResult,
33
+ getFormattedString,
34
+ } from "./useBenchmark";
35
+
36
+ export interface FlatListBenchmarkParams extends BenchmarkParams {
37
+ targetOffset: number;
38
+ }
39
+
40
+ /**
41
+ * Runs the benchmark on FlatList and calls the callback method with the result.
42
+ * Target offset is mandatory in params.
43
+ * It's recommended to remove pagination while running the benchmark. Removing the onEndReached callback is the easiest way to do that.
44
+ */
45
+ export function useFlatListBenchmark(
46
+ flatListRef: React.RefObject<FlatList<any>>,
47
+ callback: (benchmarkResult: BenchmarkResult) => void,
48
+ params: FlatListBenchmarkParams
49
+ ) {
50
+ useEffect(() => {
51
+ const cancellable = new Cancellable();
52
+ if (flatListRef.current) {
53
+ if (!(Number(flatListRef.current.props.data?.length) > 0)) {
54
+ throw new Error("Data is empty, cannot run benchmark");
55
+ }
56
+ }
57
+ const cancelTimeout = setTimeout(async () => {
58
+ const jsFPSMonitor = new JSFPSMonitor();
59
+ jsFPSMonitor.startTracking();
60
+ for (let i = 0; i < (params.repeatCount || 1); i++) {
61
+ await runScrollBenchmark(
62
+ flatListRef,
63
+ params.targetOffset,
64
+ cancellable,
65
+ params.speedMultiplier || 1
66
+ );
67
+ }
68
+ const jsProfilerResponse = jsFPSMonitor.stopAndGetData();
69
+ const result: BenchmarkResult = {
70
+ js: jsProfilerResponse,
71
+ suggestions: [],
72
+ interrupted: cancellable.isCancelled(),
73
+ };
74
+ if (!cancellable.isCancelled()) {
75
+ result.formattedString = getFormattedString(result);
76
+ }
77
+ callback(result);
78
+ }, params.startDelayInMs || 3000);
79
+ return () => {
80
+ clearTimeout(cancelTimeout);
81
+ cancellable.cancel();
82
+ };
83
+ // eslint-disable-next-line react-hooks/exhaustive-deps
84
+ }, []);
85
+ return [];
86
+ }
87
+
88
+ /**
89
+ * Scrolls to the target offset and then back to 0
90
+ */
91
+ async function runScrollBenchmark(
92
+ flatListRef: React.RefObject<FlatList<any> | null | undefined>,
93
+ targetOffset: number,
94
+ cancellable: Cancellable,
95
+ scrollSpeedMultiplier: number
96
+ ): Promise<void> {
97
+ if (flatListRef.current) {
98
+ const horizontal = flatListRef.current.props.horizontal;
99
+
100
+ const fromX = 0;
101
+ const fromY = 0;
102
+ const toX = horizontal ? targetOffset : 0;
103
+ const toY = horizontal ? 0 : targetOffset;
104
+
105
+ const scrollNow = (x: number, y: number) => {
106
+ flatListRef.current?.scrollToOffset({
107
+ offset: horizontal ? x : y,
108
+ animated: false,
109
+ });
110
+ };
111
+
112
+ await autoScroll(
113
+ scrollNow,
114
+ fromX,
115
+ fromY,
116
+ toX,
117
+ toY,
118
+ scrollSpeedMultiplier,
119
+ cancellable
120
+ );
121
+ await autoScroll(
122
+ scrollNow,
123
+ toX,
124
+ toY,
125
+ fromX,
126
+ fromY,
127
+ scrollSpeedMultiplier,
128
+ cancellable
129
+ );
130
+ }
131
+ }