@react-native-ohos/flash-list 1.8.3-rc.3 → 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.
- package/LICENSE +6 -6
- package/README.OpenSource +10 -10
- package/README.md +9 -9
- package/dist/AnimatedFlashList.d.ts +28 -25
- package/dist/AnimatedFlashList.d.ts.map +1 -1
- package/dist/AnimatedFlashList.js +30 -30
- package/dist/FlashList.d.ts +179 -179
- package/dist/FlashList.d.ts.map +1 -1
- package/dist/FlashList.js +599 -598
- package/dist/FlashList.js.map +1 -1
- package/dist/FlashListProps.d.ts +278 -278
- package/dist/FlashListProps.js +31 -31
- package/dist/GridLayoutProviderWithProps.d.ts +64 -64
- package/dist/GridLayoutProviderWithProps.js +137 -136
- package/dist/GridLayoutProviderWithProps.js.map +1 -1
- package/dist/MasonryFlashList.d.ts +73 -73
- package/dist/MasonryFlashList.d.ts.map +1 -1
- package/dist/MasonryFlashList.js +274 -274
- package/dist/MasonryFlashList.js.map +1 -1
- package/dist/PureComponentWrapper.d.ts +44 -44
- package/dist/PureComponentWrapper.js +59 -59
- package/dist/PureComponentWrapper.js.map +1 -1
- package/dist/benchmark/AutoScrollHelper.d.ts +40 -40
- package/dist/benchmark/AutoScrollHelper.js +90 -90
- package/dist/benchmark/AutoScrollHelper.js.map +1 -1
- package/dist/benchmark/JSFPSMonitor.d.ts +45 -45
- package/dist/benchmark/JSFPSMonitor.js +87 -87
- package/dist/benchmark/JSFPSMonitor.js.map +1 -1
- package/dist/benchmark/roundToDecimalPlaces.d.ts +24 -24
- package/dist/benchmark/roundToDecimalPlaces.js +31 -30
- package/dist/benchmark/roundToDecimalPlaces.js.map +1 -1
- package/dist/benchmark/useBenchmark.d.ts +57 -57
- package/dist/benchmark/useBenchmark.js +189 -188
- package/dist/benchmark/useBenchmark.js.map +1 -1
- package/dist/benchmark/useBlankAreaTracker.d.ts +56 -56
- package/dist/benchmark/useBlankAreaTracker.js +89 -88
- package/dist/benchmark/useBlankAreaTracker.js.map +1 -1
- package/dist/benchmark/useDataMultiplier.d.ts +31 -31
- package/dist/benchmark/useDataMultiplier.js +47 -46
- package/dist/benchmark/useDataMultiplier.js.map +1 -1
- package/dist/benchmark/useFlatListBenchmark.d.ts +35 -34
- package/dist/benchmark/useFlatListBenchmark.d.ts.map +1 -1
- package/dist/benchmark/useFlatListBenchmark.js +122 -121
- package/dist/benchmark/useFlatListBenchmark.js.map +1 -1
- package/dist/errors/CustomError.d.ts +30 -30
- package/dist/errors/CustomError.js +36 -36
- package/dist/errors/CustomError.js.map +1 -1
- package/dist/errors/ExceptionList.d.ts +46 -46
- package/dist/errors/ExceptionList.js +48 -48
- package/dist/errors/Warnings.d.ts +31 -31
- package/dist/errors/Warnings.js +35 -35
- package/dist/fabric/AutoLayoutNativeComponent.d.ts +41 -41
- package/dist/fabric/AutoLayoutNativeComponent.d.ts.map +1 -1
- package/dist/fabric/AutoLayoutNativeComponent.js +28 -28
- package/dist/fabric/CellContainerNativeComponent.d.ts +30 -30
- package/dist/fabric/CellContainerNativeComponent.d.ts.map +1 -1
- package/dist/fabric/CellContainerNativeComponent.js +28 -28
- package/dist/index.d.ts +36 -36
- package/dist/index.js +54 -52
- package/dist/index.js.map +1 -1
- package/dist/native/auto-layout/AutoLayoutView.d.ts +44 -44
- package/dist/native/auto-layout/AutoLayoutView.d.ts.map +1 -1
- package/dist/native/auto-layout/AutoLayoutView.js +70 -70
- package/dist/native/auto-layout/AutoLayoutView.js.map +1 -1
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.d.ts +26 -25
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.d.ts.map +1 -1
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.android.js +28 -28
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.d.ts +27 -27
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.d.ts.map +1 -1
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.d.ts +26 -25
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.d.ts.map +1 -1
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.harmony.js +28 -28
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.d.ts +26 -25
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.d.ts.map +1 -1
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.ios.js +28 -28
- package/dist/native/auto-layout/AutoLayoutViewNativeComponent.js +28 -28
- package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.d.ts +38 -38
- package/dist/native/auto-layout/AutoLayoutViewNativeComponentProps.js +25 -25
- package/dist/native/cell-container/CellContainer.android.d.ts +28 -28
- package/dist/native/cell-container/CellContainer.android.d.ts.map +1 -1
- package/dist/native/cell-container/CellContainer.android.js +31 -31
- package/dist/native/cell-container/CellContainer.d.ts +30 -29
- package/dist/native/cell-container/CellContainer.d.ts.map +1 -1
- package/dist/native/cell-container/CellContainer.harmony.d.ts +28 -28
- package/dist/native/cell-container/CellContainer.harmony.d.ts.map +1 -1
- package/dist/native/cell-container/CellContainer.harmony.js +31 -31
- package/dist/native/cell-container/CellContainer.ios.d.ts +28 -28
- package/dist/native/cell-container/CellContainer.ios.d.ts.map +1 -1
- package/dist/native/cell-container/CellContainer.ios.js +31 -31
- package/dist/native/cell-container/CellContainer.js +33 -33
- package/dist/native/cell-container/CellContainer.web.d.ts +29 -28
- package/dist/native/cell-container/CellContainer.web.d.ts.map +1 -1
- package/dist/native/cell-container/CellContainer.web.js +35 -35
- package/dist/native/config/PlatformHelper.android.d.ts +48 -48
- package/dist/native/config/PlatformHelper.android.d.ts.map +1 -1
- package/dist/native/config/PlatformHelper.android.js +45 -45
- package/dist/native/config/PlatformHelper.d.ts +48 -48
- package/dist/native/config/PlatformHelper.d.ts.map +1 -1
- package/dist/native/config/PlatformHelper.harmony.d.ts +48 -48
- package/dist/native/config/PlatformHelper.harmony.d.ts.map +1 -1
- package/dist/native/config/PlatformHelper.harmony.js +44 -44
- package/dist/native/config/PlatformHelper.ios.d.ts +48 -48
- package/dist/native/config/PlatformHelper.ios.d.ts.map +1 -1
- package/dist/native/config/PlatformHelper.ios.js +44 -44
- package/dist/native/config/PlatformHelper.js +45 -45
- package/dist/native/config/PlatformHelper.web.d.ts +49 -49
- package/dist/native/config/PlatformHelper.web.d.ts.map +1 -1
- package/dist/native/config/PlatformHelper.web.js +47 -47
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/utils/AverageWindow.d.ts +43 -43
- package/dist/utils/AverageWindow.js +71 -71
- package/dist/utils/ContentContainerUtils.d.ts +49 -49
- package/dist/utils/ContentContainerUtils.d.ts.map +1 -1
- package/dist/utils/ContentContainerUtils.js +70 -70
- package/dist/utils/ContentContainerUtils.js.map +1 -1
- package/dist/viewability/ViewToken.d.ts +30 -30
- package/dist/viewability/ViewToken.js +25 -25
- package/dist/viewability/ViewabilityHelper.d.ts +48 -48
- package/dist/viewability/ViewabilityHelper.js +129 -129
- package/dist/viewability/ViewabilityHelper.js.map +1 -1
- package/dist/viewability/ViewabilityManager.d.ts +47 -47
- package/dist/viewability/ViewabilityManager.d.ts.map +1 -1
- package/dist/viewability/ViewabilityManager.js +130 -130
- package/dist/viewability/ViewabilityManager.js.map +1 -1
- package/harmony/flash_list/BuildProfile.ets +16 -16
- package/harmony/flash_list/LICENSE +7 -7
- package/harmony/flash_list/build-profile.json5 +7 -7
- package/harmony/flash_list/hvigorfile.ts +1 -1
- package/harmony/flash_list/index.ets +27 -27
- package/harmony/flash_list/obfuscation-rules.txt +17 -17
- package/harmony/flash_list/oh-package.json5 +23 -23
- package/harmony/flash_list/src/main/cpp/AutoLayoutNode.cpp +63 -140
- package/harmony/flash_list/src/main/cpp/AutoLayoutNode.h +53 -53
- package/harmony/flash_list/src/main/cpp/AutoLayoutShadow.cpp +31 -24
- package/harmony/flash_list/src/main/cpp/AutoLayoutShadow.h +66 -66
- package/harmony/flash_list/src/main/cpp/AutoLayoutViewComponentInstance.cpp +208 -208
- package/harmony/flash_list/src/main/cpp/AutoLayoutViewComponentInstance.h +78 -78
- package/harmony/flash_list/src/main/cpp/AutoLayoutViewEventEmitRequestHandler.h +53 -53
- package/harmony/flash_list/src/main/cpp/AutoLayoutViewJSIBinder.h +50 -50
- package/harmony/flash_list/src/main/cpp/CMakeLists.txt +6 -6
- package/harmony/flash_list/src/main/cpp/CellContainerComponentInstance.cpp +79 -79
- package/harmony/flash_list/src/main/cpp/CellContainerComponentInstance.h +63 -63
- package/harmony/flash_list/src/main/cpp/CellContainerJSIBinder.h +38 -38
- package/harmony/flash_list/src/main/cpp/ComponentDescriptors.h +40 -40
- package/harmony/flash_list/src/main/cpp/EventEmitters.cpp +39 -39
- package/harmony/flash_list/src/main/cpp/EventEmitters.h +48 -48
- package/harmony/flash_list/src/main/cpp/FlashListPackage.h +77 -77
- package/harmony/flash_list/src/main/cpp/FlashListStackNode.cpp +87 -87
- package/harmony/flash_list/src/main/cpp/FlashListStackNode.h +56 -56
- package/harmony/flash_list/src/main/cpp/Props.cpp +51 -51
- package/harmony/flash_list/src/main/cpp/Props.h +64 -64
- package/harmony/flash_list/src/main/cpp/ShadowNodes.cpp +33 -33
- package/harmony/flash_list/src/main/cpp/ShadowNodes.h +48 -48
- package/harmony/flash_list/src/main/ets/Logger.ets +63 -63
- package/harmony/flash_list/src/main/ets/RNAutoLayoutShadow.ets +153 -153
- package/harmony/flash_list/src/main/ets/RNAutoLayoutView.ets +276 -276
- package/harmony/flash_list/src/main/ets/RNCellContainer.ets +113 -113
- package/harmony/flash_list/src/main/module.json5 +9 -9
- package/harmony/flash_list/src/main/resources/base/element/color.json +7 -7
- package/harmony/flash_list/src/main/resources/base/element/string.json +15 -15
- package/harmony/flash_list/src/main/resources/base/profile/main_pages.json +5 -5
- package/harmony/flash_list/src/main/resources/en_US/element/string.json +15 -15
- package/harmony/flash_list/src/main/resources/zh_CN/element/string.json +15 -15
- package/harmony/flash_list.har +0 -0
- package/jestSetup.js +40 -40
- package/package.json +82 -82
- package/src/AnimatedFlashList.ts +35 -35
- package/src/FlashList.tsx +949 -949
- package/src/FlashListProps.ts +359 -359
- package/src/GridLayoutProviderWithProps.ts +204 -204
- package/src/MasonryFlashList.tsx +499 -499
- package/src/PureComponentWrapper.tsx +65 -65
- package/src/benchmark/AutoScrollHelper.ts +94 -94
- package/src/benchmark/JSFPSMonitor.ts +98 -98
- package/src/benchmark/roundToDecimalPlaces.ts +28 -28
- package/src/benchmark/useBenchmark.ts +264 -264
- package/src/benchmark/useBlankAreaTracker.ts +141 -141
- package/src/benchmark/useDataMultiplier.ts +43 -43
- package/src/benchmark/useFlatListBenchmark.ts +131 -131
- package/src/errors/CustomError.ts +34 -34
- package/src/errors/ExceptionList.ts +52 -52
- package/src/errors/Warnings.ts +39 -39
- package/src/fabric/AutoLayoutNativeComponent.ts +52 -52
- package/src/fabric/CellContainerNativeComponent.ts +35 -35
- package/src/index.ts +67 -67
- package/src/native/auto-layout/AutoLayoutView.tsx +97 -97
- package/src/native/auto-layout/AutoLayoutViewNativeComponent.android.ts +31 -31
- package/src/native/auto-layout/AutoLayoutViewNativeComponent.harmony.ts +31 -31
- package/src/native/auto-layout/AutoLayoutViewNativeComponent.ios.ts +31 -31
- package/src/native/auto-layout/AutoLayoutViewNativeComponent.ts +31 -31
- package/src/native/auto-layout/AutoLayoutViewNativeComponentProps.ts +41 -41
- package/src/native/cell-container/CellContainer.android.ts +31 -31
- package/src/native/cell-container/CellContainer.harmony.ts +31 -31
- package/src/native/cell-container/CellContainer.ios.ts +31 -31
- package/src/native/cell-container/CellContainer.tsx +38 -38
- package/src/native/cell-container/CellContainer.web.tsx +33 -33
- package/src/native/config/PlatformHelper.android.ts +53 -53
- package/src/native/config/PlatformHelper.harmony.ts +52 -52
- package/src/native/config/PlatformHelper.ios.ts +52 -52
- package/src/native/config/PlatformHelper.ts +53 -53
- package/src/native/config/PlatformHelper.web.ts +58 -58
- package/src/utils/AverageWindow.ts +73 -73
- package/src/utils/ContentContainerUtils.ts +116 -116
- package/src/viewability/ViewToken.ts +31 -31
- package/src/viewability/ViewabilityHelper.ts +190 -190
- package/src/viewability/ViewabilityManager.ts +169 -169
|
@@ -1,130 +1,130 @@
|
|
|
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
|
-
var tslib_1 = require("tslib");
|
|
27
|
-
var CustomError_1 = tslib_1.__importDefault(require("../errors/CustomError"));
|
|
28
|
-
var ExceptionList_1 = tslib_1.__importDefault(require("../errors/ExceptionList"));
|
|
29
|
-
/**
|
|
30
|
-
* Helper class for computing viewable items based on the passed `viewabilityConfig`.
|
|
31
|
-
* Note methods in this class will be invoked on every scroll and should be optimized for performance.
|
|
32
|
-
*/
|
|
33
|
-
var ViewabilityHelper = /** @class */ (function () {
|
|
34
|
-
function ViewabilityHelper(viewabilityConfig, viewableIndicesChanged) {
|
|
35
|
-
/**
|
|
36
|
-
* Viewable indices regardless of the viewability config
|
|
37
|
-
*/
|
|
38
|
-
this.possiblyViewableIndices = [];
|
|
39
|
-
this.hasInteracted = false;
|
|
40
|
-
this.viewableIndices = [];
|
|
41
|
-
this.lastReportedViewableIndices = [];
|
|
42
|
-
this.timers = new Set();
|
|
43
|
-
this.viewabilityConfig = viewabilityConfig;
|
|
44
|
-
this.viewableIndicesChanged = viewableIndicesChanged;
|
|
45
|
-
}
|
|
46
|
-
ViewabilityHelper.prototype.dispose = function () {
|
|
47
|
-
// Clean up on dismount
|
|
48
|
-
this.timers.forEach(clearTimeout);
|
|
49
|
-
};
|
|
50
|
-
ViewabilityHelper.prototype.updateViewableItems = function (horizontal, scrollOffset, listSize, getLayout, viewableIndices) {
|
|
51
|
-
var _this = this;
|
|
52
|
-
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
53
|
-
if (viewableIndices !== undefined) {
|
|
54
|
-
this.possiblyViewableIndices = viewableIndices;
|
|
55
|
-
}
|
|
56
|
-
if (((_a = this.viewabilityConfig) === null || _a === void 0 ? void 0 : _a.itemVisiblePercentThreshold) !== null &&
|
|
57
|
-
((_b = this.viewabilityConfig) === null || _b === void 0 ? void 0 : _b.itemVisiblePercentThreshold) !== undefined &&
|
|
58
|
-
((_c = this.viewabilityConfig) === null || _c === void 0 ? void 0 : _c.viewAreaCoveragePercentThreshold) !== null &&
|
|
59
|
-
((_d = this.viewabilityConfig) === null || _d === void 0 ? void 0 : _d.viewAreaCoveragePercentThreshold) !== undefined) {
|
|
60
|
-
throw new CustomError_1.default(ExceptionList_1.default.multipleViewabilityThresholdTypesNotSupported);
|
|
61
|
-
}
|
|
62
|
-
if (((_f = (_e = this.viewabilityConfig) === null || _e === void 0 ? void 0 : _e.waitForInteraction) !== null && _f !== void 0 ? _f : false) &&
|
|
63
|
-
!this.hasInteracted) {
|
|
64
|
-
return;
|
|
65
|
-
}
|
|
66
|
-
var newViewableIndices = this.possiblyViewableIndices.filter(function (index) {
|
|
67
|
-
var _a, _b;
|
|
68
|
-
return _this.isItemViewable(index, horizontal, scrollOffset, listSize, (_a = _this.viewabilityConfig) === null || _a === void 0 ? void 0 : _a.viewAreaCoveragePercentThreshold, (_b = _this.viewabilityConfig) === null || _b === void 0 ? void 0 : _b.itemVisiblePercentThreshold, getLayout);
|
|
69
|
-
});
|
|
70
|
-
this.viewableIndices = newViewableIndices;
|
|
71
|
-
var minimumViewTime = (_h = (_g = this.viewabilityConfig) === null || _g === void 0 ? void 0 : _g.minimumViewTime) !== null && _h !== void 0 ? _h : 250;
|
|
72
|
-
// Setting default to 250. Default of 0 can impact performance when user scrolls fast.
|
|
73
|
-
if (minimumViewTime > 0) {
|
|
74
|
-
var timeoutId_1 = setTimeout(function () {
|
|
75
|
-
_this.timers.delete(timeoutId_1);
|
|
76
|
-
_this.checkViewableIndicesChanges(newViewableIndices);
|
|
77
|
-
}, minimumViewTime);
|
|
78
|
-
this.timers.add(timeoutId_1);
|
|
79
|
-
}
|
|
80
|
-
else {
|
|
81
|
-
this.checkViewableIndicesChanges(newViewableIndices);
|
|
82
|
-
}
|
|
83
|
-
};
|
|
84
|
-
ViewabilityHelper.prototype.checkViewableIndicesChanges = function (newViewableIndices) {
|
|
85
|
-
var _this = this;
|
|
86
|
-
// Check if all viewable indices are still available (applicable if minimumViewTime > 0)
|
|
87
|
-
var currentlyNewViewableIndices = newViewableIndices.filter(function (index) {
|
|
88
|
-
return _this.viewableIndices.includes(index);
|
|
89
|
-
});
|
|
90
|
-
var newlyVisibleItems = currentlyNewViewableIndices.filter(function (index) { return !_this.lastReportedViewableIndices.includes(index); });
|
|
91
|
-
var newlyNonvisibleItems = this.lastReportedViewableIndices.filter(function (index) { return !currentlyNewViewableIndices.includes(index); });
|
|
92
|
-
if (newlyVisibleItems.length > 0 || newlyNonvisibleItems.length > 0) {
|
|
93
|
-
this.lastReportedViewableIndices = currentlyNewViewableIndices;
|
|
94
|
-
this.viewableIndicesChanged(currentlyNewViewableIndices, newlyVisibleItems, newlyNonvisibleItems);
|
|
95
|
-
}
|
|
96
|
-
};
|
|
97
|
-
ViewabilityHelper.prototype.clearLastReportedViewableIndices = function () {
|
|
98
|
-
this.lastReportedViewableIndices = [];
|
|
99
|
-
};
|
|
100
|
-
ViewabilityHelper.prototype.isItemViewable = function (index, horizontal, scrollOffset, listSize, viewAreaCoveragePercentThreshold, itemVisiblePercentThreshold, getLayout) {
|
|
101
|
-
var itemLayout = getLayout(index);
|
|
102
|
-
if (itemLayout === undefined) {
|
|
103
|
-
return false;
|
|
104
|
-
}
|
|
105
|
-
var itemTop = (horizontal ? itemLayout.x : itemLayout.y) - scrollOffset;
|
|
106
|
-
var itemSize = horizontal ? itemLayout.width : itemLayout.height;
|
|
107
|
-
var listMainSize = horizontal ? listSize.width : listSize.height;
|
|
108
|
-
var pixelsVisible = Math.min(itemTop + itemSize, listMainSize) - Math.max(itemTop, 0);
|
|
109
|
-
// Always consider item fully viewable if it is fully visible, regardless of the `viewAreaCoveragePercentThreshold`
|
|
110
|
-
if (pixelsVisible === itemSize) {
|
|
111
|
-
return true;
|
|
112
|
-
}
|
|
113
|
-
// Skip checking item if it's not visible at all
|
|
114
|
-
if (pixelsVisible === 0) {
|
|
115
|
-
return false;
|
|
116
|
-
}
|
|
117
|
-
var viewAreaMode = viewAreaCoveragePercentThreshold !== null &&
|
|
118
|
-
viewAreaCoveragePercentThreshold !== undefined;
|
|
119
|
-
var percent = viewAreaMode
|
|
120
|
-
? pixelsVisible / listMainSize
|
|
121
|
-
: pixelsVisible / itemSize;
|
|
122
|
-
var viewableAreaPercentThreshold = viewAreaMode
|
|
123
|
-
? viewAreaCoveragePercentThreshold * 0.01
|
|
124
|
-
: (itemVisiblePercentThreshold !== null && itemVisiblePercentThreshold !== void 0 ? itemVisiblePercentThreshold : 0) * 0.01;
|
|
125
|
-
return percent >= viewableAreaPercentThreshold;
|
|
126
|
-
};
|
|
127
|
-
return ViewabilityHelper;
|
|
128
|
-
}());
|
|
129
|
-
exports.default = ViewabilityHelper;
|
|
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
|
+
var tslib_1 = require("tslib");
|
|
27
|
+
var CustomError_1 = tslib_1.__importDefault(require("../errors/CustomError"));
|
|
28
|
+
var ExceptionList_1 = tslib_1.__importDefault(require("../errors/ExceptionList"));
|
|
29
|
+
/**
|
|
30
|
+
* Helper class for computing viewable items based on the passed `viewabilityConfig`.
|
|
31
|
+
* Note methods in this class will be invoked on every scroll and should be optimized for performance.
|
|
32
|
+
*/
|
|
33
|
+
var ViewabilityHelper = /** @class */ (function () {
|
|
34
|
+
function ViewabilityHelper(viewabilityConfig, viewableIndicesChanged) {
|
|
35
|
+
/**
|
|
36
|
+
* Viewable indices regardless of the viewability config
|
|
37
|
+
*/
|
|
38
|
+
this.possiblyViewableIndices = [];
|
|
39
|
+
this.hasInteracted = false;
|
|
40
|
+
this.viewableIndices = [];
|
|
41
|
+
this.lastReportedViewableIndices = [];
|
|
42
|
+
this.timers = new Set();
|
|
43
|
+
this.viewabilityConfig = viewabilityConfig;
|
|
44
|
+
this.viewableIndicesChanged = viewableIndicesChanged;
|
|
45
|
+
}
|
|
46
|
+
ViewabilityHelper.prototype.dispose = function () {
|
|
47
|
+
// Clean up on dismount
|
|
48
|
+
this.timers.forEach(clearTimeout);
|
|
49
|
+
};
|
|
50
|
+
ViewabilityHelper.prototype.updateViewableItems = function (horizontal, scrollOffset, listSize, getLayout, viewableIndices) {
|
|
51
|
+
var _this = this;
|
|
52
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
53
|
+
if (viewableIndices !== undefined) {
|
|
54
|
+
this.possiblyViewableIndices = viewableIndices;
|
|
55
|
+
}
|
|
56
|
+
if (((_a = this.viewabilityConfig) === null || _a === void 0 ? void 0 : _a.itemVisiblePercentThreshold) !== null &&
|
|
57
|
+
((_b = this.viewabilityConfig) === null || _b === void 0 ? void 0 : _b.itemVisiblePercentThreshold) !== undefined &&
|
|
58
|
+
((_c = this.viewabilityConfig) === null || _c === void 0 ? void 0 : _c.viewAreaCoveragePercentThreshold) !== null &&
|
|
59
|
+
((_d = this.viewabilityConfig) === null || _d === void 0 ? void 0 : _d.viewAreaCoveragePercentThreshold) !== undefined) {
|
|
60
|
+
throw new CustomError_1.default(ExceptionList_1.default.multipleViewabilityThresholdTypesNotSupported);
|
|
61
|
+
}
|
|
62
|
+
if (((_f = (_e = this.viewabilityConfig) === null || _e === void 0 ? void 0 : _e.waitForInteraction) !== null && _f !== void 0 ? _f : false) &&
|
|
63
|
+
!this.hasInteracted) {
|
|
64
|
+
return;
|
|
65
|
+
}
|
|
66
|
+
var newViewableIndices = this.possiblyViewableIndices.filter(function (index) {
|
|
67
|
+
var _a, _b;
|
|
68
|
+
return _this.isItemViewable(index, horizontal, scrollOffset, listSize, (_a = _this.viewabilityConfig) === null || _a === void 0 ? void 0 : _a.viewAreaCoveragePercentThreshold, (_b = _this.viewabilityConfig) === null || _b === void 0 ? void 0 : _b.itemVisiblePercentThreshold, getLayout);
|
|
69
|
+
});
|
|
70
|
+
this.viewableIndices = newViewableIndices;
|
|
71
|
+
var minimumViewTime = (_h = (_g = this.viewabilityConfig) === null || _g === void 0 ? void 0 : _g.minimumViewTime) !== null && _h !== void 0 ? _h : 250;
|
|
72
|
+
// Setting default to 250. Default of 0 can impact performance when user scrolls fast.
|
|
73
|
+
if (minimumViewTime > 0) {
|
|
74
|
+
var timeoutId_1 = setTimeout(function () {
|
|
75
|
+
_this.timers.delete(timeoutId_1);
|
|
76
|
+
_this.checkViewableIndicesChanges(newViewableIndices);
|
|
77
|
+
}, minimumViewTime);
|
|
78
|
+
this.timers.add(timeoutId_1);
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
this.checkViewableIndicesChanges(newViewableIndices);
|
|
82
|
+
}
|
|
83
|
+
};
|
|
84
|
+
ViewabilityHelper.prototype.checkViewableIndicesChanges = function (newViewableIndices) {
|
|
85
|
+
var _this = this;
|
|
86
|
+
// Check if all viewable indices are still available (applicable if minimumViewTime > 0)
|
|
87
|
+
var currentlyNewViewableIndices = newViewableIndices.filter(function (index) {
|
|
88
|
+
return _this.viewableIndices.includes(index);
|
|
89
|
+
});
|
|
90
|
+
var newlyVisibleItems = currentlyNewViewableIndices.filter(function (index) { return !_this.lastReportedViewableIndices.includes(index); });
|
|
91
|
+
var newlyNonvisibleItems = this.lastReportedViewableIndices.filter(function (index) { return !currentlyNewViewableIndices.includes(index); });
|
|
92
|
+
if (newlyVisibleItems.length > 0 || newlyNonvisibleItems.length > 0) {
|
|
93
|
+
this.lastReportedViewableIndices = currentlyNewViewableIndices;
|
|
94
|
+
this.viewableIndicesChanged(currentlyNewViewableIndices, newlyVisibleItems, newlyNonvisibleItems);
|
|
95
|
+
}
|
|
96
|
+
};
|
|
97
|
+
ViewabilityHelper.prototype.clearLastReportedViewableIndices = function () {
|
|
98
|
+
this.lastReportedViewableIndices = [];
|
|
99
|
+
};
|
|
100
|
+
ViewabilityHelper.prototype.isItemViewable = function (index, horizontal, scrollOffset, listSize, viewAreaCoveragePercentThreshold, itemVisiblePercentThreshold, getLayout) {
|
|
101
|
+
var itemLayout = getLayout(index);
|
|
102
|
+
if (itemLayout === undefined) {
|
|
103
|
+
return false;
|
|
104
|
+
}
|
|
105
|
+
var itemTop = (horizontal ? itemLayout.x : itemLayout.y) - scrollOffset;
|
|
106
|
+
var itemSize = horizontal ? itemLayout.width : itemLayout.height;
|
|
107
|
+
var listMainSize = horizontal ? listSize.width : listSize.height;
|
|
108
|
+
var pixelsVisible = Math.min(itemTop + itemSize, listMainSize) - Math.max(itemTop, 0);
|
|
109
|
+
// Always consider item fully viewable if it is fully visible, regardless of the `viewAreaCoveragePercentThreshold`
|
|
110
|
+
if (pixelsVisible === itemSize) {
|
|
111
|
+
return true;
|
|
112
|
+
}
|
|
113
|
+
// Skip checking item if it's not visible at all
|
|
114
|
+
if (pixelsVisible === 0) {
|
|
115
|
+
return false;
|
|
116
|
+
}
|
|
117
|
+
var viewAreaMode = viewAreaCoveragePercentThreshold !== null &&
|
|
118
|
+
viewAreaCoveragePercentThreshold !== undefined;
|
|
119
|
+
var percent = viewAreaMode
|
|
120
|
+
? pixelsVisible / listMainSize
|
|
121
|
+
: pixelsVisible / itemSize;
|
|
122
|
+
var viewableAreaPercentThreshold = viewAreaMode
|
|
123
|
+
? viewAreaCoveragePercentThreshold * 0.01
|
|
124
|
+
: (itemVisiblePercentThreshold !== null && itemVisiblePercentThreshold !== void 0 ? itemVisiblePercentThreshold : 0) * 0.01;
|
|
125
|
+
return percent >= viewableAreaPercentThreshold;
|
|
126
|
+
};
|
|
127
|
+
return ViewabilityHelper;
|
|
128
|
+
}());
|
|
129
|
+
exports.default = ViewabilityHelper;
|
|
130
130
|
//# sourceMappingURL=ViewabilityHelper.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ViewabilityHelper.js","sourceRoot":"","sources":["../../src/viewability/ViewabilityHelper.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AAKH,8EAAgD;AAChD,kFAAoD;AAEpD;;;GAGG;AACH;IAoBE,2BACE,iBAAuD,EACvD,sBAIS;QAzBX;;WAEG;QACH,4BAAuB,GAAa,EAAE,CAAC;QAEvC,kBAAa,GAAG,KAAK,CAAC;QAEd,oBAAe,GAAa,EAAE,CAAC;QAC/B,gCAA2B,GAAa,EAAE,CAAC;QAS3C,WAAM,GAAwB,IAAI,GAAG,EAAE,CAAC;QAU9C,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;IACvD,CAAC;IAEM,mCAAO,GAAd;QACE,uBAAuB;QACvB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC;IAEM,+CAAmB,GAA1B,UACE,UAAmB,EACnB,YAAoB,EACpB,QAAmB,EACnB,SAAgD,EAChD,eAA0B;QAL5B,iBAiDC;;QA1CC,IAAI,eAAe,KAAK,SAAS,EAAE
|
|
1
|
+
{"version":3,"file":"ViewabilityHelper.js","sourceRoot":"","sources":["../../src/viewability/ViewabilityHelper.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AAKH,8EAAgD;AAChD,kFAAoD;AAEpD;;;GAGG;AACH;IAoBE,2BACE,iBAAuD,EACvD,sBAIS;QAzBX;;WAEG;QACH,4BAAuB,GAAa,EAAE,CAAC;QAEvC,kBAAa,GAAG,KAAK,CAAC;QAEd,oBAAe,GAAa,EAAE,CAAC;QAC/B,gCAA2B,GAAa,EAAE,CAAC;QAS3C,WAAM,GAAwB,IAAI,GAAG,EAAE,CAAC;QAU9C,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;IACvD,CAAC;IAEM,mCAAO,GAAd;QACE,uBAAuB;QACvB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC;IAEM,+CAAmB,GAA1B,UACE,UAAmB,EACnB,YAAoB,EACpB,QAAmB,EACnB,SAAgD,EAChD,eAA0B;QAL5B,iBAiDC;;QA1CC,IAAI,eAAe,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,uBAAuB,GAAG,eAAe,CAAC;SAChD;QACD,IACE,CAAA,MAAA,IAAI,CAAC,iBAAiB,0CAAE,2BAA2B,MAAK,IAAI;YAC5D,CAAA,MAAA,IAAI,CAAC,iBAAiB,0CAAE,2BAA2B,MAAK,SAAS;YACjE,CAAA,MAAA,IAAI,CAAC,iBAAiB,0CAAE,gCAAgC,MAAK,IAAI;YACjE,CAAA,MAAA,IAAI,CAAC,iBAAiB,0CAAE,gCAAgC,MAAK,SAAS,EACtE;YACA,MAAM,IAAI,qBAAW,CACnB,uBAAa,CAAC,6CAA6C,CAC5D,CAAC;SACH;QACD,IACE,CAAC,MAAA,MAAA,IAAI,CAAC,iBAAiB,0CAAE,kBAAkB,mCAAI,KAAK,CAAC;YACrD,CAAC,IAAI,CAAC,aAAa,EACnB;YACA,OAAO;SACR;QACD,IAAM,kBAAkB,GAAG,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,UAAC,KAAK;;YACnE,OAAA,KAAI,CAAC,cAAc,CACjB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,MAAA,KAAI,CAAC,iBAAiB,0CAAE,gCAAgC,EACxD,MAAA,KAAI,CAAC,iBAAiB,0CAAE,2BAA2B,EACnD,SAAS,CACV,CAAA;SAAA,CACF,CAAC;QACF,IAAI,CAAC,eAAe,GAAG,kBAAkB,CAAC;QAC1C,IAAM,eAAe,GAAG,MAAA,MAAA,IAAI,CAAC,iBAAiB,0CAAE,eAAe,mCAAI,GAAG,CAAC;QACvE,sFAAsF;QACtF,IAAI,eAAe,GAAG,CAAC,EAAE;YACvB,IAAM,WAAS,GAAG,UAAU,CAAC;gBAC3B,KAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAS,CAAC,CAAC;gBAC9B,KAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;YACvD,CAAC,EAAE,eAAe,CAAC,CAAC;YACpB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAS,CAAC,CAAC;SAC5B;aAAM;YACL,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;SACtD;IACH,CAAC;IAEM,uDAA2B,GAAlC,UAAmC,kBAA4B;QAA/D,iBAoBC;QAnBC,wFAAwF;QACxF,IAAM,2BAA2B,GAAG,kBAAkB,CAAC,MAAM,CAAC,UAAC,KAAK;YAClE,OAAA,KAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC;QAApC,CAAoC,CACrC,CAAC;QACF,IAAM,iBAAiB,GAAG,2BAA2B,CAAC,MAAM,CAC1D,UAAC,KAAK,IAAK,OAAA,CAAC,KAAI,CAAC,2BAA2B,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAjD,CAAiD,CAC7D,CAAC;QACF,IAAM,oBAAoB,GAAG,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAClE,UAAC,KAAK,IAAK,OAAA,CAAC,2BAA2B,CAAC,QAAQ,CAAC,KAAK,CAAC,EAA5C,CAA4C,CACxD,CAAC;QAEF,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;YACnE,IAAI,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;YAC/D,IAAI,CAAC,sBAAsB,CACzB,2BAA2B,EAC3B,iBAAiB,EACjB,oBAAoB,CACrB,CAAC;SACH;IACH,CAAC;IAEM,4DAAgC,GAAvC;QACE,IAAI,CAAC,2BAA2B,GAAG,EAAE,CAAC;IACxC,CAAC;IAEO,0CAAc,GAAtB,UACE,KAAa,EACb,UAAmB,EACnB,YAAoB,EACpB,QAAmB,EACnB,gCAA2D,EAC3D,2BAAsD,EACtD,SAAgD;QAEhD,IAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,OAAO,KAAK,CAAC;SACd;QACD,IAAM,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC;QAC1E,IAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;QACnE,IAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;QACnE,IAAM,aAAa,GACjB,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,QAAQ,EAAE,YAAY,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAEpE,mHAAmH;QACnH,IAAI,aAAa,KAAK,QAAQ,EAAE;YAC9B,OAAO,IAAI,CAAC;SACb;QACD,gDAAgD;QAChD,IAAI,aAAa,KAAK,CAAC,EAAE;YACvB,OAAO,KAAK,CAAC;SACd;QACD,IAAM,YAAY,GAChB,gCAAgC,KAAK,IAAI;YACzC,gCAAgC,KAAK,SAAS,CAAC;QACjD,IAAM,OAAO,GAAG,YAAY;YAC1B,CAAC,CAAC,aAAa,GAAG,YAAY;YAC9B,CAAC,CAAC,aAAa,GAAG,QAAQ,CAAC;QAC7B,IAAM,4BAA4B,GAAG,YAAY;YAC/C,CAAC,CAAC,gCAAgC,GAAG,IAAI;YACzC,CAAC,CAAC,CAAC,2BAA2B,aAA3B,2BAA2B,cAA3B,2BAA2B,GAAI,CAAC,CAAC,GAAG,IAAI,CAAC;QAE9C,OAAO,OAAO,IAAI,4BAA4B,CAAC;IACjD,CAAC;IACH,wBAAC;AAAD,CAAC,AAzJD,IAyJC;AAED,kBAAe,iBAAiB,CAAC"}
|
|
@@ -1,48 +1,48 @@
|
|
|
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 FlashList from "../FlashList";
|
|
25
|
-
/**
|
|
26
|
-
* Manager for viewability tracking. It holds multiple viewability callback pairs and keeps them updated.
|
|
27
|
-
*/
|
|
28
|
-
export default class ViewabilityManager<T> {
|
|
29
|
-
private flashListRef;
|
|
30
|
-
private viewabilityHelpers;
|
|
31
|
-
private hasInteracted;
|
|
32
|
-
constructor(flashListRef: FlashList<T>);
|
|
33
|
-
/**
|
|
34
|
-
* @returns true if the viewability manager has any viewability callback pairs registered.
|
|
35
|
-
*/
|
|
36
|
-
get shouldListenToVisibleIndices(): boolean;
|
|
37
|
-
dispose: () => void;
|
|
38
|
-
onVisibleIndicesChanged: (all: number[]) => void;
|
|
39
|
-
recordInteraction: () => void;
|
|
40
|
-
updateViewableItems: (newViewableIndices?: number[]) => void;
|
|
41
|
-
recomputeViewableItems: () => void;
|
|
42
|
-
/**
|
|
43
|
-
* Creates a new `ViewabilityHelper` instance with `onViewableItemsChanged` callback and `ViewabilityConfig`
|
|
44
|
-
* @returns `ViewabilityHelper` instance
|
|
45
|
-
*/
|
|
46
|
-
private createViewabilityHelper;
|
|
47
|
-
}
|
|
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 FlashList from "../FlashList";
|
|
25
|
+
/**
|
|
26
|
+
* Manager for viewability tracking. It holds multiple viewability callback pairs and keeps them updated.
|
|
27
|
+
*/
|
|
28
|
+
export default class ViewabilityManager<T> {
|
|
29
|
+
private flashListRef;
|
|
30
|
+
private viewabilityHelpers;
|
|
31
|
+
private hasInteracted;
|
|
32
|
+
constructor(flashListRef: FlashList<T>);
|
|
33
|
+
/**
|
|
34
|
+
* @returns true if the viewability manager has any viewability callback pairs registered.
|
|
35
|
+
*/
|
|
36
|
+
get shouldListenToVisibleIndices(): boolean;
|
|
37
|
+
dispose: () => void;
|
|
38
|
+
onVisibleIndicesChanged: (all: number[]) => void;
|
|
39
|
+
recordInteraction: () => void;
|
|
40
|
+
updateViewableItems: (newViewableIndices?: number[]) => void;
|
|
41
|
+
recomputeViewableItems: () => void;
|
|
42
|
+
/**
|
|
43
|
+
* Creates a new `ViewabilityHelper` instance with `onViewableItemsChanged` callback and `ViewabilityConfig`
|
|
44
|
+
* @returns `ViewabilityHelper` instance
|
|
45
|
+
*/
|
|
46
|
+
private createViewabilityHelper;
|
|
47
|
+
}
|
|
48
48
|
//# sourceMappingURL=ViewabilityManager.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ViewabilityManager.d.ts","sourceRoot":"","sources":["../../src/viewability/ViewabilityManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAIH,OAAO,SAAS,MAAM,cAAc,CAAC;AAKrC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB,CAAC,CAAC;IACvC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,kBAAkB,CAA2B;IACrD,OAAO,CAAC,aAAa,CAAS;gBAElB,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IA6BtC;;OAEG;IACH,IAAW,4BAA4B,YAEtC;IAEM,OAAO,aAIZ;IAEK,uBAAuB,
|
|
1
|
+
{"version":3,"file":"ViewabilityManager.d.ts","sourceRoot":"","sources":["../../src/viewability/ViewabilityManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAIH,OAAO,SAAS,MAAM,cAAc,CAAC;AAKrC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB,CAAC,CAAC;IACvC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,kBAAkB,CAA2B;IACrD,OAAO,CAAC,aAAa,CAAS;gBAElB,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IA6BtC;;OAEG;IACH,IAAW,4BAA4B,YAEtC;IAEM,OAAO,aAIZ;IAEK,uBAAuB,QAAS,MAAM,EAAE,UAE7C;IAEK,iBAAiB,aAStB;IAEK,mBAAmB,wBAAyB,MAAM,EAAE,UAmBzD;IAEK,sBAAsB,aAM3B;IAEF;;;OAGG;IACH,OAAO,CAAC,uBAAuB,CAsC7B;CACH"}
|