@react-native-ohos/flash-list 1.8.3-rc.3 → 1.8.3-rc.5

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 (246) 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/__tests__/AverageWindow.test.d.ts +2 -0
  24. package/dist/__tests__/AverageWindow.test.d.ts.map +1 -0
  25. package/dist/__tests__/AverageWindow.test.js +69 -0
  26. package/dist/__tests__/AverageWindow.test.js.map +1 -0
  27. package/dist/__tests__/ContentContainerUtils.test.d.ts +2 -0
  28. package/dist/__tests__/ContentContainerUtils.test.d.ts.map +1 -0
  29. package/dist/__tests__/ContentContainerUtils.test.js +85 -0
  30. package/dist/__tests__/ContentContainerUtils.test.js.map +1 -0
  31. package/dist/__tests__/FlashList.test.d.ts +2 -0
  32. package/dist/__tests__/FlashList.test.d.ts.map +1 -0
  33. package/dist/__tests__/FlashList.test.js +792 -0
  34. package/dist/__tests__/FlashList.test.js.map +1 -0
  35. package/dist/__tests__/GridLayoutProviderWithProps.test.d.ts +2 -0
  36. package/dist/__tests__/GridLayoutProviderWithProps.test.d.ts.map +1 -0
  37. package/dist/__tests__/GridLayoutProviderWithProps.test.js +143 -0
  38. package/dist/__tests__/GridLayoutProviderWithProps.test.js.map +1 -0
  39. package/dist/__tests__/MasonryFlashList.test.d.ts +2 -0
  40. package/dist/__tests__/MasonryFlashList.test.d.ts.map +1 -0
  41. package/dist/__tests__/MasonryFlashList.test.js +254 -0
  42. package/dist/__tests__/MasonryFlashList.test.js.map +1 -0
  43. package/dist/__tests__/PlatformHelper.web.test.d.ts +2 -0
  44. package/dist/__tests__/PlatformHelper.web.test.d.ts.map +1 -0
  45. package/dist/__tests__/PlatformHelper.web.test.js +33 -0
  46. package/dist/__tests__/PlatformHelper.web.test.js.map +1 -0
  47. package/dist/__tests__/ViewabilityHelper.test.d.ts +2 -0
  48. package/dist/__tests__/ViewabilityHelper.test.d.ts.map +1 -0
  49. package/dist/__tests__/ViewabilityHelper.test.js +187 -0
  50. package/dist/__tests__/ViewabilityHelper.test.js.map +1 -0
  51. package/dist/__tests__/helpers/mountFlashList.d.ts +19 -0
  52. package/dist/__tests__/helpers/mountFlashList.d.ts.map +1 -0
  53. package/dist/__tests__/helpers/mountFlashList.js +44 -0
  54. package/dist/__tests__/helpers/mountFlashList.js.map +1 -0
  55. package/dist/__tests__/helpers/mountMasonryFlashList.d.ts +18 -0
  56. package/dist/__tests__/helpers/mountMasonryFlashList.d.ts.map +1 -0
  57. package/dist/__tests__/helpers/mountMasonryFlashList.js +49 -0
  58. package/dist/__tests__/helpers/mountMasonryFlashList.js.map +1 -0
  59. package/dist/__tests__/useBlankAreaTracker.test.d.ts +2 -0
  60. package/dist/__tests__/useBlankAreaTracker.test.d.ts.map +1 -0
  61. package/dist/__tests__/useBlankAreaTracker.test.js +177 -0
  62. package/dist/__tests__/useBlankAreaTracker.test.js.map +1 -0
  63. package/dist/benchmark/AutoScrollHelper.d.ts +40 -40
  64. package/dist/benchmark/AutoScrollHelper.js +90 -90
  65. package/dist/benchmark/AutoScrollHelper.js.map +1 -1
  66. package/dist/benchmark/JSFPSMonitor.d.ts +45 -45
  67. package/dist/benchmark/JSFPSMonitor.js +87 -87
  68. package/dist/benchmark/JSFPSMonitor.js.map +1 -1
  69. package/dist/benchmark/roundToDecimalPlaces.d.ts +24 -24
  70. package/dist/benchmark/roundToDecimalPlaces.js +31 -30
  71. package/dist/benchmark/roundToDecimalPlaces.js.map +1 -1
  72. package/dist/benchmark/useBenchmark.d.ts +57 -57
  73. package/dist/benchmark/useBenchmark.js +189 -188
  74. package/dist/benchmark/useBenchmark.js.map +1 -1
  75. package/dist/benchmark/useBlankAreaTracker.d.ts +56 -56
  76. package/dist/benchmark/useBlankAreaTracker.js +89 -88
  77. package/dist/benchmark/useBlankAreaTracker.js.map +1 -1
  78. package/dist/benchmark/useDataMultiplier.d.ts +31 -31
  79. package/dist/benchmark/useDataMultiplier.js +47 -46
  80. package/dist/benchmark/useDataMultiplier.js.map +1 -1
  81. package/dist/benchmark/useFlatListBenchmark.d.ts +35 -34
  82. package/dist/benchmark/useFlatListBenchmark.d.ts.map +1 -1
  83. package/dist/benchmark/useFlatListBenchmark.js +122 -121
  84. package/dist/benchmark/useFlatListBenchmark.js.map +1 -1
  85. package/dist/errors/CustomError.d.ts +30 -30
  86. package/dist/errors/CustomError.js +36 -36
  87. package/dist/errors/CustomError.js.map +1 -1
  88. package/dist/errors/ExceptionList.d.ts +46 -46
  89. package/dist/errors/ExceptionList.js +48 -48
  90. package/dist/errors/Warnings.d.ts +31 -31
  91. package/dist/errors/Warnings.js +35 -35
  92. package/dist/fabric/AutoLayoutNativeComponent.d.ts +41 -41
  93. package/dist/fabric/AutoLayoutNativeComponent.d.ts.map +1 -1
  94. package/dist/fabric/AutoLayoutNativeComponent.js +28 -28
  95. package/dist/fabric/CellContainerNativeComponent.d.ts +30 -30
  96. package/dist/fabric/CellContainerNativeComponent.d.ts.map +1 -1
  97. package/dist/fabric/CellContainerNativeComponent.js +28 -28
  98. package/dist/index.d.ts +36 -36
  99. package/dist/index.js +54 -52
  100. package/dist/index.js.map +1 -1
  101. package/dist/native/auto-layout/AutoLayoutView.d.ts +44 -44
  102. package/dist/native/auto-layout/AutoLayoutView.d.ts.map +1 -1
  103. package/dist/native/auto-layout/AutoLayoutView.js +70 -70
  104. package/dist/native/auto-layout/AutoLayoutView.js.map +1 -1
  105. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.d.ts +26 -25
  106. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.d.ts.map +1 -1
  107. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.js +28 -28
  108. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.d.ts +27 -27
  109. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.d.ts.map +1 -1
  110. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.d.ts +26 -25
  111. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.d.ts.map +1 -1
  112. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.js +28 -28
  113. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.d.ts +26 -25
  114. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.d.ts.map +1 -1
  115. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.js +28 -28
  116. package/dist/native/auto-layout/AutoLayoutViewNativeComponent.js +28 -28
  117. package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.d.ts +38 -38
  118. package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.js +25 -25
  119. package/dist/native/cell-container/CellContainer.android.d.ts +28 -28
  120. package/dist/native/cell-container/CellContainer.android.d.ts.map +1 -1
  121. package/dist/native/cell-container/CellContainer.android.js +31 -31
  122. package/dist/native/cell-container/CellContainer.d.ts +30 -29
  123. package/dist/native/cell-container/CellContainer.d.ts.map +1 -1
  124. package/dist/native/cell-container/CellContainer.harmony.d.ts +28 -28
  125. package/dist/native/cell-container/CellContainer.harmony.d.ts.map +1 -1
  126. package/dist/native/cell-container/CellContainer.harmony.js +31 -31
  127. package/dist/native/cell-container/CellContainer.ios.d.ts +28 -28
  128. package/dist/native/cell-container/CellContainer.ios.d.ts.map +1 -1
  129. package/dist/native/cell-container/CellContainer.ios.js +31 -31
  130. package/dist/native/cell-container/CellContainer.js +33 -33
  131. package/dist/native/cell-container/CellContainer.web.d.ts +29 -28
  132. package/dist/native/cell-container/CellContainer.web.d.ts.map +1 -1
  133. package/dist/native/cell-container/CellContainer.web.js +35 -35
  134. package/dist/native/config/PlatformHelper.android.d.ts +48 -48
  135. package/dist/native/config/PlatformHelper.android.d.ts.map +1 -1
  136. package/dist/native/config/PlatformHelper.android.js +45 -45
  137. package/dist/native/config/PlatformHelper.d.ts +48 -48
  138. package/dist/native/config/PlatformHelper.d.ts.map +1 -1
  139. package/dist/native/config/PlatformHelper.harmony.d.ts +48 -48
  140. package/dist/native/config/PlatformHelper.harmony.d.ts.map +1 -1
  141. package/dist/native/config/PlatformHelper.harmony.js +44 -44
  142. package/dist/native/config/PlatformHelper.ios.d.ts +48 -48
  143. package/dist/native/config/PlatformHelper.ios.d.ts.map +1 -1
  144. package/dist/native/config/PlatformHelper.ios.js +44 -44
  145. package/dist/native/config/PlatformHelper.js +45 -45
  146. package/dist/native/config/PlatformHelper.web.d.ts +49 -49
  147. package/dist/native/config/PlatformHelper.web.d.ts.map +1 -1
  148. package/dist/native/config/PlatformHelper.web.js +47 -47
  149. package/dist/tsconfig.tsbuildinfo +1 -1
  150. package/dist/utils/AverageWindow.d.ts +43 -43
  151. package/dist/utils/AverageWindow.js +71 -71
  152. package/dist/utils/ContentContainerUtils.d.ts +49 -49
  153. package/dist/utils/ContentContainerUtils.d.ts.map +1 -1
  154. package/dist/utils/ContentContainerUtils.js +70 -70
  155. package/dist/utils/ContentContainerUtils.js.map +1 -1
  156. package/dist/viewability/ViewToken.d.ts +30 -30
  157. package/dist/viewability/ViewToken.js +25 -25
  158. package/dist/viewability/ViewabilityHelper.d.ts +48 -48
  159. package/dist/viewability/ViewabilityHelper.js +129 -129
  160. package/dist/viewability/ViewabilityHelper.js.map +1 -1
  161. package/dist/viewability/ViewabilityManager.d.ts +47 -47
  162. package/dist/viewability/ViewabilityManager.d.ts.map +1 -1
  163. package/dist/viewability/ViewabilityManager.js +130 -130
  164. package/dist/viewability/ViewabilityManager.js.map +1 -1
  165. package/harmony/flash_list/BuildProfile.ets +16 -16
  166. package/harmony/flash_list/LICENSE +7 -7
  167. package/harmony/flash_list/build-profile.json5 +7 -7
  168. package/harmony/flash_list/hvigorfile.ts +1 -1
  169. package/harmony/flash_list/index.ets +27 -27
  170. package/harmony/flash_list/obfuscation-rules.txt +17 -17
  171. package/harmony/flash_list/oh-package.json5 +23 -23
  172. package/harmony/flash_list/src/main/cpp/AutoLayoutNode.cpp +63 -140
  173. package/harmony/flash_list/src/main/cpp/AutoLayoutNode.h +53 -53
  174. package/harmony/flash_list/src/main/cpp/AutoLayoutShadow.cpp +31 -24
  175. package/harmony/flash_list/src/main/cpp/AutoLayoutShadow.h +66 -66
  176. package/harmony/flash_list/src/main/cpp/AutoLayoutViewComponentInstance.cpp +208 -208
  177. package/harmony/flash_list/src/main/cpp/AutoLayoutViewComponentInstance.h +78 -78
  178. package/harmony/flash_list/src/main/cpp/AutoLayoutViewEventEmitRequestHandler.h +53 -53
  179. package/harmony/flash_list/src/main/cpp/AutoLayoutViewJSIBinder.h +50 -50
  180. package/harmony/flash_list/src/main/cpp/CMakeLists.txt +12 -7
  181. package/harmony/flash_list/src/main/cpp/CellContainerComponentInstance.cpp +79 -79
  182. package/harmony/flash_list/src/main/cpp/CellContainerComponentInstance.h +63 -63
  183. package/harmony/flash_list/src/main/cpp/CellContainerJSIBinder.h +38 -38
  184. package/harmony/flash_list/src/main/cpp/ComponentDescriptors.h +40 -40
  185. package/harmony/flash_list/src/main/cpp/EventEmitters.cpp +39 -39
  186. package/harmony/flash_list/src/main/cpp/EventEmitters.h +48 -48
  187. package/harmony/flash_list/src/main/cpp/FlashListPackage.h +85 -77
  188. package/harmony/flash_list/src/main/cpp/FlashListStackNode.cpp +87 -87
  189. package/harmony/flash_list/src/main/cpp/FlashListStackNode.h +56 -56
  190. package/harmony/flash_list/src/main/cpp/Props.cpp +51 -51
  191. package/harmony/flash_list/src/main/cpp/Props.h +64 -64
  192. package/harmony/flash_list/src/main/cpp/ShadowNodes.cpp +33 -33
  193. package/harmony/flash_list/src/main/cpp/ShadowNodes.h +48 -48
  194. package/harmony/flash_list/src/main/ets/Logger.ets +63 -63
  195. package/harmony/flash_list/src/main/ets/RNAutoLayoutShadow.ets +153 -153
  196. package/harmony/flash_list/src/main/ets/RNAutoLayoutView.ets +276 -276
  197. package/harmony/flash_list/src/main/ets/RNCellContainer.ets +113 -113
  198. package/harmony/flash_list/src/main/module.json5 +9 -9
  199. package/harmony/flash_list/src/main/resources/base/element/color.json +7 -7
  200. package/harmony/flash_list/src/main/resources/base/element/string.json +15 -15
  201. package/harmony/flash_list/src/main/resources/base/profile/main_pages.json +5 -5
  202. package/harmony/flash_list/src/main/resources/en_US/element/string.json +15 -15
  203. package/harmony/flash_list/src/main/resources/zh_CN/element/string.json +15 -15
  204. package/harmony/flash_list.har +0 -0
  205. package/jestSetup.js +40 -40
  206. package/package.json +82 -82
  207. package/src/AnimatedFlashList.ts +35 -35
  208. package/src/FlashList.tsx +949 -949
  209. package/src/FlashListProps.ts +359 -359
  210. package/src/GridLayoutProviderWithProps.ts +204 -204
  211. package/src/MasonryFlashList.tsx +499 -499
  212. package/src/PureComponentWrapper.tsx +65 -65
  213. package/src/benchmark/AutoScrollHelper.ts +94 -94
  214. package/src/benchmark/JSFPSMonitor.ts +98 -98
  215. package/src/benchmark/roundToDecimalPlaces.ts +28 -28
  216. package/src/benchmark/useBenchmark.ts +264 -264
  217. package/src/benchmark/useBlankAreaTracker.ts +141 -141
  218. package/src/benchmark/useDataMultiplier.ts +43 -43
  219. package/src/benchmark/useFlatListBenchmark.ts +131 -131
  220. package/src/errors/CustomError.ts +34 -34
  221. package/src/errors/ExceptionList.ts +52 -52
  222. package/src/errors/Warnings.ts +39 -39
  223. package/src/fabric/AutoLayoutNativeComponent.ts +52 -52
  224. package/src/fabric/CellContainerNativeComponent.ts +35 -35
  225. package/src/index.ts +67 -67
  226. package/src/native/auto-layout/AutoLayoutView.tsx +97 -97
  227. package/src/native/auto-layout/AutoLayoutViewNativeComponent.android.ts +31 -31
  228. package/src/native/auto-layout/AutoLayoutViewNativeComponent.harmony.ts +31 -31
  229. package/src/native/auto-layout/AutoLayoutViewNativeComponent.ios.ts +31 -31
  230. package/src/native/auto-layout/AutoLayoutViewNativeComponent.ts +31 -31
  231. package/src/native/auto-layout/AutoLayoutViewNativeComponentProps.ts +41 -41
  232. package/src/native/cell-container/CellContainer.android.ts +31 -31
  233. package/src/native/cell-container/CellContainer.harmony.ts +31 -31
  234. package/src/native/cell-container/CellContainer.ios.ts +31 -31
  235. package/src/native/cell-container/CellContainer.tsx +38 -38
  236. package/src/native/cell-container/CellContainer.web.tsx +33 -33
  237. package/src/native/config/PlatformHelper.android.ts +53 -53
  238. package/src/native/config/PlatformHelper.harmony.ts +52 -52
  239. package/src/native/config/PlatformHelper.ios.ts +52 -52
  240. package/src/native/config/PlatformHelper.ts +53 -53
  241. package/src/native/config/PlatformHelper.web.ts +58 -58
  242. package/src/utils/AverageWindow.ts +73 -73
  243. package/src/utils/ContentContainerUtils.ts +116 -116
  244. package/src/viewability/ViewToken.ts +31 -31
  245. package/src/viewability/ViewabilityHelper.ts +190 -190
  246. package/src/viewability/ViewabilityManager.ts +169 -169
@@ -1,57 +1,57 @@
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 from "react";
25
- import { BlankAreaEvent } from "../native/auto-layout/AutoLayoutView";
26
- import FlashList from "../FlashList";
27
- export interface BlankAreaTrackerResult {
28
- /**
29
- * Max blank area displayed
30
- */
31
- maxBlankArea: number;
32
- /**
33
- * Sum of all blank area values across all frames
34
- */
35
- cumulativeBlankArea: number;
36
- }
37
- export interface BlankAreaTrackerConfig {
38
- /**
39
- * When set to true the hook will also sum all negative blank area values.
40
- * Blank area is negative when list is able to draw faster than the scroll speed.
41
- */
42
- sumNegativeValues?: boolean;
43
- /**
44
- * By default, the hook ignores blank events for 1s after the list load. This value can be changed using this parameter.
45
- * Please note that this duration kicks in after the list has loaded and not after the first scroll.
46
- */
47
- startDelayInMs?: number;
48
- }
49
- /**
50
- * Can be used to track visible blank area in production
51
- * @param flashListRef Ref to the FlashList component
52
- * @param onBlankAreaChange This event handler will be called when the blank area changes
53
- * @param config additional configuration for the blank area tracker
54
- * @returns blankAreaTrackerResult - maxBlankArea, cumulativeBlankArea this object is mutated and kept up to date. Also returns a callback that needs to be forwarded to FlashList.
55
- */
56
- export declare function useBlankAreaTracker(flashListRef: React.RefObject<FlashList<any>>, onBlankAreaChange?: (value: BlankAreaTrackerResult) => void, config?: BlankAreaTrackerConfig): [BlankAreaTrackerResult, (event: BlankAreaEvent) => void];
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 from "react";
25
+ import { BlankAreaEvent } from "../native/auto-layout/AutoLayoutView";
26
+ import FlashList from "../FlashList";
27
+ export interface BlankAreaTrackerResult {
28
+ /**
29
+ * Max blank area displayed
30
+ */
31
+ maxBlankArea: number;
32
+ /**
33
+ * Sum of all blank area values across all frames
34
+ */
35
+ cumulativeBlankArea: number;
36
+ }
37
+ export interface BlankAreaTrackerConfig {
38
+ /**
39
+ * When set to true the hook will also sum all negative blank area values.
40
+ * Blank area is negative when list is able to draw faster than the scroll speed.
41
+ */
42
+ sumNegativeValues?: boolean;
43
+ /**
44
+ * By default, the hook ignores blank events for 1s after the list load. This value can be changed using this parameter.
45
+ * Please note that this duration kicks in after the list has loaded and not after the first scroll.
46
+ */
47
+ startDelayInMs?: number;
48
+ }
49
+ /**
50
+ * Can be used to track visible blank area in production
51
+ * @param flashListRef Ref to the FlashList component
52
+ * @param onBlankAreaChange This event handler will be called when the blank area changes
53
+ * @param config additional configuration for the blank area tracker
54
+ * @returns blankAreaTrackerResult - maxBlankArea, cumulativeBlankArea this object is mutated and kept up to date. Also returns a callback that needs to be forwarded to FlashList.
55
+ */
56
+ export declare function useBlankAreaTracker(flashListRef: React.RefObject<FlashList<any>>, onBlankAreaChange?: (value: BlankAreaTrackerResult) => void, config?: BlankAreaTrackerConfig): [BlankAreaTrackerResult, (event: BlankAreaEvent) => void];
57
57
  //# sourceMappingURL=useBlankAreaTracker.d.ts.map
@@ -1,89 +1,90 @@
1
- "use strict";
2
- /**
3
- * MIT License
4
- *
5
- * Copyright (C) 2024 Huawei Device Co., Ltd.
6
- *
7
- * Permission is hereby granted, free of charge, to any person obtaining a copy
8
- * of this software and associated documentation files (the "Software"), to deal
9
- * in the Software without restriction, including without limitation the rights
10
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
- * copies of the Software, and to permit persons to whom the Software is
12
- * furnished to do so, subject to the following conditions:
13
- *
14
- * The above copyright notice and this permission notice shall be included in all
15
- * copies or substantial portions of the Software.
16
- *
17
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
- * SOFTWARE.
24
- */
25
- Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.useBlankAreaTracker = useBlankAreaTracker;
27
- var react_1 = require("react");
28
- /**
29
- * Can be used to track visible blank area in production
30
- * @param flashListRef Ref to the FlashList component
31
- * @param onBlankAreaChange This event handler will be called when the blank area changes
32
- * @param config additional configuration for the blank area tracker
33
- * @returns blankAreaTrackerResult - maxBlankArea, cumulativeBlankArea this object is mutated and kept up to date. Also returns a callback that needs to be forwarded to FlashList.
34
- */
35
- function useBlankAreaTracker(flashListRef, onBlankAreaChange, config) {
36
- var _a;
37
- var startDelay = (_a = config === null || config === void 0 ? void 0 : config.startDelayInMs) !== null && _a !== void 0 ? _a : 1000;
38
- var blankAreaResult = (0, react_1.useRef)({
39
- maxBlankArea: 0,
40
- cumulativeBlankArea: 0,
41
- }).current;
42
- var waitOperations = (0, react_1.useRef)({ inProgress: false, complete: false }).current;
43
- var onBlankAreaChangeRef = (0, react_1.useRef)(onBlankAreaChange);
44
- onBlankAreaChangeRef.current = onBlankAreaChange;
45
- var blankAreaTracker = (0, react_1.useCallback)(function (event) {
46
- var _a, _b;
47
- // we're ignoring some of the events that will be fired on list load
48
- // initial events are fired on mount and thus, this won't lead to missing events during scroll
49
- if (!waitOperations.complete && startDelay > 0) {
50
- if (!waitOperations.inProgress) {
51
- waitOperations.inProgress = true;
52
- setTimeout(function () {
53
- waitOperations.complete = true;
54
- }, startDelay);
55
- }
56
- return;
57
- }
58
- var rlv = (_a = flashListRef.current) === null || _a === void 0 ? void 0 : _a.recyclerlistview_unsafe;
59
- var horizontal = Boolean((_b = flashListRef.current) === null || _b === void 0 ? void 0 : _b.props.horizontal);
60
- if (rlv) {
61
- processBlankAreaChange(rlv, horizontal, blankAreaResult, event, onBlankAreaChangeRef.current, config);
62
- }
63
- },
64
- // eslint-disable-next-line react-hooks/exhaustive-deps
65
- [flashListRef]);
66
- return [blankAreaResult, blankAreaTracker];
67
- }
68
- function processBlankAreaChange(rlv, horizontal, blankAreaResult, event, onBlankAreaChange, config) {
69
- var listSize = horizontal
70
- ? rlv.getRenderedSize().width
71
- : rlv.getRenderedSize().height;
72
- var contentSize = horizontal
73
- ? rlv.getContentDimension().width
74
- : rlv.getContentDimension().height;
75
- // ignores blank events when there isn't enough content to fill the list
76
- if (contentSize > listSize) {
77
- var lastMaxBlankArea = blankAreaResult.maxBlankArea;
78
- var lastCumulativeBlankArea = blankAreaResult.cumulativeBlankArea;
79
- blankAreaResult.maxBlankArea = Math.max(blankAreaResult.maxBlankArea, event.blankArea, 0);
80
- blankAreaResult.cumulativeBlankArea += (config === null || config === void 0 ? void 0 : config.sumNegativeValues)
81
- ? event.blankArea
82
- : Math.max(event.blankArea, 0);
83
- if (lastCumulativeBlankArea !== blankAreaResult.cumulativeBlankArea ||
84
- lastMaxBlankArea !== blankAreaResult.maxBlankArea) {
85
- onBlankAreaChange === null || onBlankAreaChange === void 0 ? void 0 : onBlankAreaChange(blankAreaResult);
86
- }
87
- }
88
- }
1
+ "use strict";
2
+ /**
3
+ * MIT License
4
+ *
5
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
6
+ *
7
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ * of this software and associated documentation files (the "Software"), to deal
9
+ * in the Software without restriction, including without limitation the rights
10
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ * copies of the Software, and to permit persons to whom the Software is
12
+ * furnished to do so, subject to the following conditions:
13
+ *
14
+ * The above copyright notice and this permission notice shall be included in all
15
+ * copies or substantial portions of the Software.
16
+ *
17
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
+ * SOFTWARE.
24
+ */
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.useBlankAreaTracker = void 0;
27
+ var react_1 = require("react");
28
+ /**
29
+ * Can be used to track visible blank area in production
30
+ * @param flashListRef Ref to the FlashList component
31
+ * @param onBlankAreaChange This event handler will be called when the blank area changes
32
+ * @param config additional configuration for the blank area tracker
33
+ * @returns blankAreaTrackerResult - maxBlankArea, cumulativeBlankArea this object is mutated and kept up to date. Also returns a callback that needs to be forwarded to FlashList.
34
+ */
35
+ function useBlankAreaTracker(flashListRef, onBlankAreaChange, config) {
36
+ var _a;
37
+ var startDelay = (_a = config === null || config === void 0 ? void 0 : config.startDelayInMs) !== null && _a !== void 0 ? _a : 1000;
38
+ var blankAreaResult = (0, react_1.useRef)({
39
+ maxBlankArea: 0,
40
+ cumulativeBlankArea: 0,
41
+ }).current;
42
+ var waitOperations = (0, react_1.useRef)({ inProgress: false, complete: false }).current;
43
+ var onBlankAreaChangeRef = (0, react_1.useRef)(onBlankAreaChange);
44
+ onBlankAreaChangeRef.current = onBlankAreaChange;
45
+ var blankAreaTracker = (0, react_1.useCallback)(function (event) {
46
+ var _a, _b;
47
+ // we're ignoring some of the events that will be fired on list load
48
+ // initial events are fired on mount and thus, this won't lead to missing events during scroll
49
+ if (!waitOperations.complete && startDelay > 0) {
50
+ if (!waitOperations.inProgress) {
51
+ waitOperations.inProgress = true;
52
+ setTimeout(function () {
53
+ waitOperations.complete = true;
54
+ }, startDelay);
55
+ }
56
+ return;
57
+ }
58
+ var rlv = (_a = flashListRef.current) === null || _a === void 0 ? void 0 : _a.recyclerlistview_unsafe;
59
+ var horizontal = Boolean((_b = flashListRef.current) === null || _b === void 0 ? void 0 : _b.props.horizontal);
60
+ if (rlv) {
61
+ processBlankAreaChange(rlv, horizontal, blankAreaResult, event, onBlankAreaChangeRef.current, config);
62
+ }
63
+ },
64
+ // eslint-disable-next-line react-hooks/exhaustive-deps
65
+ [flashListRef]);
66
+ return [blankAreaResult, blankAreaTracker];
67
+ }
68
+ exports.useBlankAreaTracker = useBlankAreaTracker;
69
+ function processBlankAreaChange(rlv, horizontal, blankAreaResult, event, onBlankAreaChange, config) {
70
+ var listSize = horizontal
71
+ ? rlv.getRenderedSize().width
72
+ : rlv.getRenderedSize().height;
73
+ var contentSize = horizontal
74
+ ? rlv.getContentDimension().width
75
+ : rlv.getContentDimension().height;
76
+ // ignores blank events when there isn't enough content to fill the list
77
+ if (contentSize > listSize) {
78
+ var lastMaxBlankArea = blankAreaResult.maxBlankArea;
79
+ var lastCumulativeBlankArea = blankAreaResult.cumulativeBlankArea;
80
+ blankAreaResult.maxBlankArea = Math.max(blankAreaResult.maxBlankArea, event.blankArea, 0);
81
+ blankAreaResult.cumulativeBlankArea += (config === null || config === void 0 ? void 0 : config.sumNegativeValues)
82
+ ? event.blankArea
83
+ : Math.max(event.blankArea, 0);
84
+ if (lastCumulativeBlankArea !== blankAreaResult.cumulativeBlankArea ||
85
+ lastMaxBlankArea !== blankAreaResult.maxBlankArea) {
86
+ onBlankAreaChange === null || onBlankAreaChange === void 0 ? void 0 : onBlankAreaChange(blankAreaResult);
87
+ }
88
+ }
89
+ }
89
90
  //# sourceMappingURL=useBlankAreaTracker.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"useBlankAreaTracker.js","sourceRoot":"","sources":["../../src/benchmark/useBlankAreaTracker.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;AAsCH,kDA4CC;AAhFD,+BAAmD;AA6BnD;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,YAA6C,EAC7C,iBAA2D,EAC3D,MAA+B;;IAE/B,IAAM,UAAU,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,cAAc,mCAAI,IAAI,CAAC;IAClD,IAAM,eAAe,GAAG,IAAA,cAAM,EAAC;QAC7B,YAAY,EAAE,CAAC;QACf,mBAAmB,EAAE,CAAC;KACvB,CAAC,CAAC,OAAO,CAAC;IACX,IAAM,cAAc,GAAG,IAAA,cAAM,EAAC,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC;IAC9E,IAAM,oBAAoB,GAAG,IAAA,cAAM,EAAC,iBAAiB,CAAC,CAAC;IACvD,oBAAoB,CAAC,OAAO,GAAG,iBAAiB,CAAC;IAEjD,IAAM,gBAAgB,GAAG,IAAA,mBAAW,EAClC,UAAC,KAAqB;;QACpB,oEAAoE;QACpE,8FAA8F;QAC9F,IAAI,CAAC,cAAc,CAAC,QAAQ,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YAC/C,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;gBAC/B,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;gBACjC,UAAU,CAAC;oBACT,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACjC,CAAC,EAAE,UAAU,CAAC,CAAC;YACjB,CAAC;YACD,OAAO;QACT,CAAC;QACD,IAAM,GAAG,GAAG,MAAA,YAAY,CAAC,OAAO,0CAAE,uBAAuB,CAAC;QAC1D,IAAM,UAAU,GAAG,OAAO,CAAC,MAAA,YAAY,CAAC,OAAO,0CAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,GAAG,EAAE,CAAC;YACR,sBAAsB,CACpB,GAAG,EACH,UAAU,EACV,eAAe,EACf,KAAK,EACL,oBAAoB,CAAC,OAAO,EAC5B,MAAM,CACP,CAAC;QACJ,CAAC;IACH,CAAC;IACD,uDAAuD;IACvD,CAAC,YAAY,CAAC,CACf,CAAC;IACF,OAAO,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,sBAAsB,CAC7B,GAAiD,EACjD,UAAmB,EACnB,eAAuC,EACvC,KAAqB,EACrB,iBAA2D,EAC3D,MAA+B;IAE/B,IAAM,QAAQ,GAAG,UAAU;QACzB,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,KAAK;QAC7B,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC;IACjC,IAAM,WAAW,GAAG,UAAU;QAC5B,CAAC,CAAC,GAAG,CAAC,mBAAmB,EAAE,CAAC,KAAK;QACjC,CAAC,CAAC,GAAG,CAAC,mBAAmB,EAAE,CAAC,MAAM,CAAC;IAErC,wEAAwE;IACxE,IAAI,WAAW,GAAG,QAAQ,EAAE,CAAC;QAC3B,IAAM,gBAAgB,GAAG,eAAe,CAAC,YAAY,CAAC;QACtD,IAAM,uBAAuB,GAAG,eAAe,CAAC,mBAAmB,CAAC;QACpE,eAAe,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CACrC,eAAe,CAAC,YAAY,EAC5B,KAAK,CAAC,SAAS,EACf,CAAC,CACF,CAAC;QACF,eAAe,CAAC,mBAAmB,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,iBAAiB;YAC9D,CAAC,CAAC,KAAK,CAAC,SAAS;YACjB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACjC,IACE,uBAAuB,KAAK,eAAe,CAAC,mBAAmB;YAC/D,gBAAgB,KAAK,eAAe,CAAC,YAAY,EACjD,CAAC;YACD,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAG,eAAe,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"useBlankAreaTracker.js","sourceRoot":"","sources":["../../src/benchmark/useBlankAreaTracker.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AAEH,+BAAmD;AA6BnD;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,YAA6C,EAC7C,iBAA2D,EAC3D,MAA+B;;IAE/B,IAAM,UAAU,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,cAAc,mCAAI,IAAI,CAAC;IAClD,IAAM,eAAe,GAAG,IAAA,cAAM,EAAC;QAC7B,YAAY,EAAE,CAAC;QACf,mBAAmB,EAAE,CAAC;KACvB,CAAC,CAAC,OAAO,CAAC;IACX,IAAM,cAAc,GAAG,IAAA,cAAM,EAAC,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC;IAC9E,IAAM,oBAAoB,GAAG,IAAA,cAAM,EAAC,iBAAiB,CAAC,CAAC;IACvD,oBAAoB,CAAC,OAAO,GAAG,iBAAiB,CAAC;IAEjD,IAAM,gBAAgB,GAAG,IAAA,mBAAW,EAClC,UAAC,KAAqB;;QACpB,oEAAoE;QACpE,8FAA8F;QAC9F,IAAI,CAAC,cAAc,CAAC,QAAQ,IAAI,UAAU,GAAG,CAAC,EAAE;YAC9C,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE;gBAC9B,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;gBACjC,UAAU,CAAC;oBACT,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACjC,CAAC,EAAE,UAAU,CAAC,CAAC;aAChB;YACD,OAAO;SACR;QACD,IAAM,GAAG,GAAG,MAAA,YAAY,CAAC,OAAO,0CAAE,uBAAuB,CAAC;QAC1D,IAAM,UAAU,GAAG,OAAO,CAAC,MAAA,YAAY,CAAC,OAAO,0CAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,GAAG,EAAE;YACP,sBAAsB,CACpB,GAAG,EACH,UAAU,EACV,eAAe,EACf,KAAK,EACL,oBAAoB,CAAC,OAAO,EAC5B,MAAM,CACP,CAAC;SACH;IACH,CAAC;IACD,uDAAuD;IACvD,CAAC,YAAY,CAAC,CACf,CAAC;IACF,OAAO,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;AAC7C,CAAC;AA5CD,kDA4CC;AAED,SAAS,sBAAsB,CAC7B,GAAiD,EACjD,UAAmB,EACnB,eAAuC,EACvC,KAAqB,EACrB,iBAA2D,EAC3D,MAA+B;IAE/B,IAAM,QAAQ,GAAG,UAAU;QACzB,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,KAAK;QAC7B,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC;IACjC,IAAM,WAAW,GAAG,UAAU;QAC5B,CAAC,CAAC,GAAG,CAAC,mBAAmB,EAAE,CAAC,KAAK;QACjC,CAAC,CAAC,GAAG,CAAC,mBAAmB,EAAE,CAAC,MAAM,CAAC;IAErC,wEAAwE;IACxE,IAAI,WAAW,GAAG,QAAQ,EAAE;QAC1B,IAAM,gBAAgB,GAAG,eAAe,CAAC,YAAY,CAAC;QACtD,IAAM,uBAAuB,GAAG,eAAe,CAAC,mBAAmB,CAAC;QACpE,eAAe,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CACrC,eAAe,CAAC,YAAY,EAC5B,KAAK,CAAC,SAAS,EACf,CAAC,CACF,CAAC;QACF,eAAe,CAAC,mBAAmB,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,iBAAiB;YAC9D,CAAC,CAAC,KAAK,CAAC,SAAS;YACjB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACjC,IACE,uBAAuB,KAAK,eAAe,CAAC,mBAAmB;YAC/D,gBAAgB,KAAK,eAAe,CAAC,YAAY,EACjD;YACA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAG,eAAe,CAAC,CAAC;SACtC;KACF;AACH,CAAC"}
@@ -1,32 +1,32 @@
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
- * Increases the data size by duplicating it, it's kept in hook format so that in future we can add auto pagination support.
26
- * 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.
27
- * @param data The data to duplicate
28
- * @param count Final count of data to be returned from this hook
29
- * @returns Multiplied data.
30
- */
31
- export declare function useDataMultiplier<T>(data: T[], count: number): [T[]];
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
+ * Increases the data size by duplicating it, it's kept in hook format so that in future we can add auto pagination support.
26
+ * 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.
27
+ * @param data The data to duplicate
28
+ * @param count Final count of data to be returned from this hook
29
+ * @returns Multiplied data.
30
+ */
31
+ export declare function useDataMultiplier<T>(data: T[], count: number): [T[]];
32
32
  //# sourceMappingURL=useDataMultiplier.d.ts.map
@@ -1,47 +1,48 @@
1
- "use strict";
2
- /**
3
- * MIT License
4
- *
5
- * Copyright (C) 2024 Huawei Device Co., Ltd.
6
- *
7
- * Permission is hereby granted, free of charge, to any person obtaining a copy
8
- * of this software and associated documentation files (the "Software"), to deal
9
- * in the Software without restriction, including without limitation the rights
10
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
- * copies of the Software, and to permit persons to whom the Software is
12
- * furnished to do so, subject to the following conditions:
13
- *
14
- * The above copyright notice and this permission notice shall be included in all
15
- * copies or substantial portions of the Software.
16
- *
17
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
- * SOFTWARE.
24
- */
25
- Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.useDataMultiplier = useDataMultiplier;
27
- var tslib_1 = require("tslib");
28
- /**
29
- * Increases the data size by duplicating it, it's kept in hook format so that in future we can add auto pagination support.
30
- * 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.
31
- * @param data The data to duplicate
32
- * @param count Final count of data to be returned from this hook
33
- * @returns Multiplied data.
34
- */
35
- function useDataMultiplier(data, count) {
36
- var len = data.length;
37
- var arr = new Array(count);
38
- var isObject = false;
39
- if (typeof data[0] === "object") {
40
- isObject = true;
41
- }
42
- for (var i = 0; i < count; i++) {
43
- arr[i] = isObject ? tslib_1.__assign({}, data[i % len]) : data[i % len];
44
- }
45
- return [arr];
46
- }
1
+ "use strict";
2
+ /**
3
+ * MIT License
4
+ *
5
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
6
+ *
7
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ * of this software and associated documentation files (the "Software"), to deal
9
+ * in the Software without restriction, including without limitation the rights
10
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ * copies of the Software, and to permit persons to whom the Software is
12
+ * furnished to do so, subject to the following conditions:
13
+ *
14
+ * The above copyright notice and this permission notice shall be included in all
15
+ * copies or substantial portions of the Software.
16
+ *
17
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
+ * SOFTWARE.
24
+ */
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.useDataMultiplier = void 0;
27
+ var tslib_1 = require("tslib");
28
+ /**
29
+ * Increases the data size by duplicating it, it's kept in hook format so that in future we can add auto pagination support.
30
+ * 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.
31
+ * @param data The data to duplicate
32
+ * @param count Final count of data to be returned from this hook
33
+ * @returns Multiplied data.
34
+ */
35
+ function useDataMultiplier(data, count) {
36
+ var len = data.length;
37
+ var arr = new Array(count);
38
+ var isObject = false;
39
+ if (typeof data[0] === "object") {
40
+ isObject = true;
41
+ }
42
+ for (var i = 0; i < count; i++) {
43
+ arr[i] = isObject ? tslib_1.__assign({}, data[i % len]) : data[i % len];
44
+ }
45
+ return [arr];
46
+ }
47
+ exports.useDataMultiplier = useDataMultiplier;
47
48
  //# sourceMappingURL=useDataMultiplier.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"useDataMultiplier.js","sourceRoot":"","sources":["../../src/benchmark/useDataMultiplier.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;AASH,8CAWC;;AAlBD;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAI,IAAS,EAAE,KAAa;IAC3D,IAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;IACxB,IAAM,GAAG,GAAG,IAAI,KAAK,CAAI,KAAK,CAAC,CAAC;IAChC,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QAChC,QAAQ,GAAG,IAAI,CAAC;IAClB,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,sBAAM,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,EAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,CAAC;AACf,CAAC"}
1
+ {"version":3,"file":"useDataMultiplier.js","sourceRoot":"","sources":["../../src/benchmark/useDataMultiplier.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;;AAEH;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAI,IAAS,EAAE,KAAa;IAC3D,IAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;IACxB,IAAM,GAAG,GAAG,IAAI,KAAK,CAAI,KAAK,CAAC,CAAC;IAChC,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;QAC/B,QAAQ,GAAG,IAAI,CAAC;KACjB;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;QAC9B,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,sBAAM,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,EAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;KAC1D;IACD,OAAO,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAXD,8CAWC"}
@@ -1,35 +1,36 @@
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 { FlatList } from "react-native";
25
- import { BenchmarkParams, BenchmarkResult } from "./useBenchmark";
26
- export interface FlatListBenchmarkParams extends BenchmarkParams {
27
- targetOffset: number;
28
- }
29
- /**
30
- * Runs the benchmark on FlatList and calls the callback method with the result.
31
- * Target offset is mandatory in params.
32
- * It's recommended to remove pagination while running the benchmark. Removing the onEndReached callback is the easiest way to do that.
33
- */
34
- export declare function useFlatListBenchmark(flatListRef: React.RefObject<FlatList<any>>, callback: (benchmarkResult: BenchmarkResult) => void, params: FlatListBenchmarkParams): never[];
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
+ /// <reference types="react" />
25
+ import { FlatList } from "react-native";
26
+ import { BenchmarkParams, BenchmarkResult } from "./useBenchmark";
27
+ export interface FlatListBenchmarkParams extends BenchmarkParams {
28
+ targetOffset: number;
29
+ }
30
+ /**
31
+ * Runs the benchmark on FlatList and calls the callback method with the result.
32
+ * Target offset is mandatory in params.
33
+ * It's recommended to remove pagination while running the benchmark. Removing the onEndReached callback is the easiest way to do that.
34
+ */
35
+ export declare function useFlatListBenchmark(flatListRef: React.RefObject<FlatList<any>>, callback: (benchmarkResult: BenchmarkResult) => void, params: FlatListBenchmarkParams): never[];
35
36
  //# sourceMappingURL=useFlatListBenchmark.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"useFlatListBenchmark.d.ts","sourceRoot":"","sources":["../../src/benchmark/useFlatListBenchmark.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAIxC,OAAO,EACL,eAAe,EACf,eAAe,EAEhB,MAAM,gBAAgB,CAAC;AAExB,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAC3C,QAAQ,EAAE,CAAC,eAAe,EAAE,eAAe,KAAK,IAAI,EACpD,MAAM,EAAE,uBAAuB,WAsChC"}
1
+ {"version":3,"file":"useFlatListBenchmark.d.ts","sourceRoot":"","sources":["../../src/benchmark/useFlatListBenchmark.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAIxC,OAAO,EACL,eAAe,EACf,eAAe,EAEhB,MAAM,gBAAgB,CAAC;AAExB,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAC3C,QAAQ,EAAE,CAAC,eAAe,EAAE,eAAe,KAAK,IAAI,EACpD,MAAM,EAAE,uBAAuB,WAsChC"}