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

package/src/viewability/ViewabilityManager.ts

@@ -1,169 +1,169 @@
-/**
- * MIT License
- *
- * Copyright (C) 2024 Huawei Device Co., Ltd.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { ViewabilityConfig } from "react-native";
-
-import FlashList from "../FlashList";
-
-import ViewabilityHelper from "./ViewabilityHelper";
-import ViewToken from "./ViewToken";
-
-/**
- * Manager for viewability tracking. It holds multiple viewability callback pairs and keeps them updated.
- */
-export default class ViewabilityManager<T> {
-  private flashListRef: FlashList<T>;
-  private viewabilityHelpers: ViewabilityHelper[] = [];
-  private hasInteracted = false;
-
-  constructor(flashListRef: FlashList<T>) {
-    this.flashListRef = flashListRef;
-    if (
-      flashListRef.props.onViewableItemsChanged !== null &&
-      flashListRef.props.onViewableItemsChanged !== undefined
-    ) {
-      this.viewabilityHelpers.push(
-        this.createViewabilityHelper(
-          flashListRef.props.viewabilityConfig,
-          (info) => {
-            flashListRef.props.onViewableItemsChanged?.(info);
-          }
-        )
-      );
-    }
-    (flashListRef.props.viewabilityConfigCallbackPairs ?? []).forEach(
-      (pair, index) => {
-        this.viewabilityHelpers.push(
-          this.createViewabilityHelper(pair.viewabilityConfig, (info) => {
-            const callback =
-              flashListRef.props.viewabilityConfigCallbackPairs?.[index]
-                ?.onViewableItemsChanged;
-            callback?.(info);
-          })
-        );
-      }
-    );
-  }
-
-  /**
-   * @returns true if the viewability manager has any viewability callback pairs registered.
-   */
-  public get shouldListenToVisibleIndices() {
-    return this.viewabilityHelpers.length > 0;
-  }
-
-  public dispose = () => {
-    this.viewabilityHelpers.forEach((viewabilityHelper) =>
-      viewabilityHelper.dispose()
-    );
-  };
-
-  public onVisibleIndicesChanged = (all: number[]) => {
-    this.updateViewableItems(all);
-  };
-
-  public recordInteraction = () => {
-    if (this.hasInteracted) {
-      return;
-    }
-    this.hasInteracted = true;
-    this.viewabilityHelpers.forEach((viewabilityHelper) => {
-      viewabilityHelper.hasInteracted = true;
-    });
-    this.updateViewableItems();
-  };
-
-  public updateViewableItems = (newViewableIndices?: number[]) => {
-    const listSize =
-      this.flashListRef.getWindowSize() ??
-      this.flashListRef.props.estimatedListSize;
-    if (listSize === undefined || !this.shouldListenToVisibleIndices) {
-      return;
-    }
-    const scrollOffset =
-      (this.flashListRef.getAbsoluteLastScrollOffset() ?? 0) -
-      this.flashListRef.firstItemOffset;
-    this.viewabilityHelpers.forEach((viewabilityHelper) => {
-      viewabilityHelper.updateViewableItems(
-        this.flashListRef.props.horizontal ?? false,
-        scrollOffset,
-        listSize,
-        (index: number) => this.flashListRef.getLayout(index),
-        newViewableIndices
-      );
-    });
-  };
-
-  public recomputeViewableItems = () => {
-    this.viewabilityHelpers.forEach((viewabilityHelper) =>
-      viewabilityHelper.clearLastReportedViewableIndices()
-    );
-
-    this.updateViewableItems();
-  };
-
-  /**
-   * Creates a new `ViewabilityHelper` instance with `onViewableItemsChanged` callback and `ViewabilityConfig`
-   * @returns `ViewabilityHelper` instance
-   */
-  private createViewabilityHelper = (
-    viewabilityConfig: ViewabilityConfig | null | undefined,
-    onViewableItemsChanged:
-      | ((info: { viewableItems: ViewToken[]; changed: ViewToken[] }) => void)
-      | null
-      | undefined
-  ) => {
-    const mapViewToken: (index: number, isViewable: boolean) => ViewToken = (
-      index: number,
-      isViewable: boolean
-    ) => {
-      const item = this.flashListRef.props.data?.[index];
-      const key =
-        item === undefined || this.flashListRef.props.keyExtractor === undefined
-          ? index.toString()
-          : this.flashListRef.props.keyExtractor(item, index);
-      return {
-        index,
-        isViewable,
-        item,
-        key,
-        timestamp: Date.now(),
-      };
-    };
-    return new ViewabilityHelper(
-      viewabilityConfig,
-      (indices, newlyVisibleIndices, newlyNonvisibleIndices) => {
-        onViewableItemsChanged?.({
-          viewableItems: indices.map((index) => mapViewToken(index, true)),
-          changed: [
-            ...newlyVisibleIndices.map((index) => mapViewToken(index, true)),
-            ...newlyNonvisibleIndices.map((index) =>
-              mapViewToken(index, false)
-            ),
-          ],
-        });
-      }
-    );
-  };
-}
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { ViewabilityConfig } from "react-native";
+
+import FlashList from "../FlashList";
+
+import ViewabilityHelper from "./ViewabilityHelper";
+import ViewToken from "./ViewToken";
+
+/**
+ * Manager for viewability tracking. It holds multiple viewability callback pairs and keeps them updated.
+ */
+export default class ViewabilityManager<T> {
+  private flashListRef: FlashList<T>;
+  private viewabilityHelpers: ViewabilityHelper[] = [];
+  private hasInteracted = false;
+
+  constructor(flashListRef: FlashList<T>) {
+    this.flashListRef = flashListRef;
+    if (
+      flashListRef.props.onViewableItemsChanged !== null &&
+      flashListRef.props.onViewableItemsChanged !== undefined
+    ) {
+      this.viewabilityHelpers.push(
+        this.createViewabilityHelper(
+          flashListRef.props.viewabilityConfig,
+          (info) => {
+            flashListRef.props.onViewableItemsChanged?.(info);
+          }
+        )
+      );
+    }
+    (flashListRef.props.viewabilityConfigCallbackPairs ?? []).forEach(
+      (pair, index) => {
+        this.viewabilityHelpers.push(
+          this.createViewabilityHelper(pair.viewabilityConfig, (info) => {
+            const callback =
+              flashListRef.props.viewabilityConfigCallbackPairs?.[index]
+                ?.onViewableItemsChanged;
+            callback?.(info);
+          })
+        );
+      }
+    );
+  }
+
+  /**
+   * @returns true if the viewability manager has any viewability callback pairs registered.
+   */
+  public get shouldListenToVisibleIndices() {
+    return this.viewabilityHelpers.length > 0;
+  }
+
+  public dispose = () => {
+    this.viewabilityHelpers.forEach((viewabilityHelper) =>
+      viewabilityHelper.dispose()
+    );
+  };
+
+  public onVisibleIndicesChanged = (all: number[]) => {
+    this.updateViewableItems(all);
+  };
+
+  public recordInteraction = () => {
+    if (this.hasInteracted) {
+      return;
+    }
+    this.hasInteracted = true;
+    this.viewabilityHelpers.forEach((viewabilityHelper) => {
+      viewabilityHelper.hasInteracted = true;
+    });
+    this.updateViewableItems();
+  };
+
+  public updateViewableItems = (newViewableIndices?: number[]) => {
+    const listSize =
+      this.flashListRef.getWindowSize() ??
+      this.flashListRef.props.estimatedListSize;
+    if (listSize === undefined || !this.shouldListenToVisibleIndices) {
+      return;
+    }
+    const scrollOffset =
+      (this.flashListRef.getAbsoluteLastScrollOffset() ?? 0) -
+      this.flashListRef.firstItemOffset;
+    this.viewabilityHelpers.forEach((viewabilityHelper) => {
+      viewabilityHelper.updateViewableItems(
+        this.flashListRef.props.horizontal ?? false,
+        scrollOffset,
+        listSize,
+        (index: number) => this.flashListRef.getLayout(index),
+        newViewableIndices
+      );
+    });
+  };
+
+  public recomputeViewableItems = () => {
+    this.viewabilityHelpers.forEach((viewabilityHelper) =>
+      viewabilityHelper.clearLastReportedViewableIndices()
+    );
+
+    this.updateViewableItems();
+  };
+
+  /**
+   * Creates a new `ViewabilityHelper` instance with `onViewableItemsChanged` callback and `ViewabilityConfig`
+   * @returns `ViewabilityHelper` instance
+   */
+  private createViewabilityHelper = (
+    viewabilityConfig: ViewabilityConfig | null | undefined,
+    onViewableItemsChanged:
+      | ((info: { viewableItems: ViewToken[]; changed: ViewToken[] }) => void)
+      | null
+      | undefined
+  ) => {
+    const mapViewToken: (index: number, isViewable: boolean) => ViewToken = (
+      index: number,
+      isViewable: boolean
+    ) => {
+      const item = this.flashListRef.props.data?.[index];
+      const key =
+        item === undefined || this.flashListRef.props.keyExtractor === undefined
+          ? index.toString()
+          : this.flashListRef.props.keyExtractor(item, index);
+      return {
+        index,
+        isViewable,
+        item,
+        key,
+        timestamp: Date.now(),
+      };
+    };
+    return new ViewabilityHelper(
+      viewabilityConfig,
+      (indices, newlyVisibleIndices, newlyNonvisibleIndices) => {
+        onViewableItemsChanged?.({
+          viewableItems: indices.map((index) => mapViewToken(index, true)),
+          changed: [
+            ...newlyVisibleIndices.map((index) => mapViewToken(index, true)),
+            ...newlyNonvisibleIndices.map((index) =>
+              mapViewToken(index, false)
+            ),
+          ],
+        });
+      }
+    );
+  };
+}