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

package/src/PureComponentWrapper.tsx

@@ -1,65 +1,65 @@
-/**
- * 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 React, { JSX } from "react";
-
-export interface PureComponentWrapperProps {
-  renderer: (arg: unknown) => JSX.Element | null;
-
-  /** Renderer is called with this argument.
-   * Don't change this value everytime or else component will always rerender. Prefer primitives. */
-  arg?: unknown;
-  enabled?: boolean;
-  [other: string]: unknown;
-}
-
-/**
- * Pure component wrapper that can be used to prevent renders of the `renderer` method passed to the component. Any change in props will lead to `renderer` getting called.
- */
-export class PureComponentWrapper extends React.PureComponent<PureComponentWrapperProps> {
-  static defaultProps = {
-    enabled: true,
-  };
-
-  private overrideEnabled: boolean | undefined = undefined;
-
-  /** Once set explicitly, prop will be ignored. Not using state because of performance reasons. */
-  public setEnabled(enabled: boolean) {
-    if (enabled !== this.overrideEnabled) {
-      this.overrideEnabled = enabled;
-      this.forceUpdate();
-    }
-  }
-
-  render() {
-    if (this.overrideEnabled === undefined) {
-      return (
-        (this.props.enabled && this.props.renderer(this.props.arg)) || null
-      );
-    } else {
-      return (
-        (this.overrideEnabled && this.props.renderer(this.props.arg)) || null
-      );
-    }
-  }
-}
+/**
+ * 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 React, { JSX } from "react";
+
+export interface PureComponentWrapperProps {
+  renderer: (arg: unknown) => JSX.Element | null;
+
+  /** Renderer is called with this argument.
+   * Don't change this value everytime or else component will always rerender. Prefer primitives. */
+  arg?: unknown;
+  enabled?: boolean;
+  [other: string]: unknown;
+}
+
+/**
+ * Pure component wrapper that can be used to prevent renders of the `renderer` method passed to the component. Any change in props will lead to `renderer` getting called.
+ */
+export class PureComponentWrapper extends React.PureComponent<PureComponentWrapperProps> {
+  static defaultProps = {
+    enabled: true,
+  };
+
+  private overrideEnabled: boolean | undefined = undefined;
+
+  /** Once set explicitly, prop will be ignored. Not using state because of performance reasons. */
+  public setEnabled(enabled: boolean) {
+    if (enabled !== this.overrideEnabled) {
+      this.overrideEnabled = enabled;
+      this.forceUpdate();
+    }
+  }
+
+  render() {
+    if (this.overrideEnabled === undefined) {
+      return (
+        (this.props.enabled && this.props.renderer(this.props.arg)) || null
+      );
+    } else {
+      return (
+        (this.overrideEnabled && this.props.renderer(this.props.arg)) || null
+      );
+    }
+  }
+}

package/src/benchmark/AutoScrollHelper.ts

@@ -1,94 +1,94 @@
-/**
- * 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.
- */
-
-/**
- * This method can be used to trigger scroll events that can be forwarded to an element. Anything that implements scrollable can leverage this.
- * @param scroll The scrollable element
- * @param fromX The x offset to start from
- * @param fromY The y offset to start from
- * @param toX the x offset to end scroll at
- * @param toY the y offset to end scroll at
- * @param speedMultiplier  the speed multiplier to use
- * @param cancellable can be used to cancel the scroll
- * @returns Promise that resolves when the scroll is complete
- */
-export function autoScroll(
-  scroll: (x: number, y: number, animated: boolean) => void,
-  fromX: number,
-  fromY: number,
-  toX: number,
-  toY: number,
-  speedMultiplier = 1,
-  cancellable: Cancellable = new Cancellable()
-): Promise<boolean> {
-  return new Promise((resolve) => {
-    scroll(fromX, fromY, false);
-    // Very fast scrolls on Android/iOS typically move content 7px every millisecond.
-    const incrementPerMs = 7 * speedMultiplier;
-    const directionMultiplierX = toX > fromX ? 1 : -1;
-    const directionMultiplierY = toY > fromY ? 1 : -1;
-    const comparatorX = toX > fromX ? Math.min : Math.max;
-    const comparatorY = toY > fromY ? Math.min : Math.max;
-    let startTime = Date.now();
-    let startX = fromX;
-    let startY = fromY;
-    // Computes the number of pixels to scroll in the given time
-    // Also invokes the scrollable to update the scroll position
-    const animationLoop = () => {
-      requestAnimationFrame(() => {
-        if (cancellable.isCancelled()) {
-          resolve(false);
-          return;
-        }
-        const currentTime = Date.now();
-        const timeElapsed = currentTime - startTime;
-        const distanceToCover = incrementPerMs * timeElapsed;
-        startX += distanceToCover * directionMultiplierX;
-        startY += distanceToCover * directionMultiplierY;
-        scroll(comparatorX(toX, startX), comparatorY(toY, startY), false);
-        startTime = currentTime;
-        if (
-          comparatorX(toX, startX) !== toX ||
-          comparatorY(toY, startY) !== toY
-        ) {
-          return animationLoop();
-        }
-        resolve(true);
-      });
-    };
-    animationLoop();
-  });
-}
-
-export class Cancellable {
-  public cancel() {
-    this._isCancelled = true;
-  }
-
-  public isCancelled(): boolean {
-    return this._isCancelled;
-  }
-
-  public _isCancelled = 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.
+ */
+
+/**
+ * This method can be used to trigger scroll events that can be forwarded to an element. Anything that implements scrollable can leverage this.
+ * @param scroll The scrollable element
+ * @param fromX The x offset to start from
+ * @param fromY The y offset to start from
+ * @param toX the x offset to end scroll at
+ * @param toY the y offset to end scroll at
+ * @param speedMultiplier  the speed multiplier to use
+ * @param cancellable can be used to cancel the scroll
+ * @returns Promise that resolves when the scroll is complete
+ */
+export function autoScroll(
+  scroll: (x: number, y: number, animated: boolean) => void,
+  fromX: number,
+  fromY: number,
+  toX: number,
+  toY: number,
+  speedMultiplier = 1,
+  cancellable: Cancellable = new Cancellable()
+): Promise<boolean> {
+  return new Promise((resolve) => {
+    scroll(fromX, fromY, false);
+    // Very fast scrolls on Android/iOS typically move content 7px every millisecond.
+    const incrementPerMs = 7 * speedMultiplier;
+    const directionMultiplierX = toX > fromX ? 1 : -1;
+    const directionMultiplierY = toY > fromY ? 1 : -1;
+    const comparatorX = toX > fromX ? Math.min : Math.max;
+    const comparatorY = toY > fromY ? Math.min : Math.max;
+    let startTime = Date.now();
+    let startX = fromX;
+    let startY = fromY;
+    // Computes the number of pixels to scroll in the given time
+    // Also invokes the scrollable to update the scroll position
+    const animationLoop = () => {
+      requestAnimationFrame(() => {
+        if (cancellable.isCancelled()) {
+          resolve(false);
+          return;
+        }
+        const currentTime = Date.now();
+        const timeElapsed = currentTime - startTime;
+        const distanceToCover = incrementPerMs * timeElapsed;
+        startX += distanceToCover * directionMultiplierX;
+        startY += distanceToCover * directionMultiplierY;
+        scroll(comparatorX(toX, startX), comparatorY(toY, startY), false);
+        startTime = currentTime;
+        if (
+          comparatorX(toX, startX) !== toX ||
+          comparatorY(toY, startY) !== toY
+        ) {
+          return animationLoop();
+        }
+        resolve(true);
+      });
+    };
+    animationLoop();
+  });
+}
+
+export class Cancellable {
+  public cancel() {
+    this._isCancelled = true;
+  }
+
+  public isCancelled(): boolean {
+    return this._isCancelled;
+  }
+
+  public _isCancelled = false;
+}

package/src/benchmark/JSFPSMonitor.ts

@@ -1,98 +1,98 @@
-/**
- * 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 { roundToDecimalPlaces } from "./roundToDecimalPlaces";
-
-/**
- * Can be used to monitor JS thread performance
- * Use startTracking() and stopAndGetData() to start and stop tracking
- */
-export class JSFPSMonitor {
-  private startTime = 0;
-  private frameCount = 0;
-  private timeWindow = {
-    frameCount: 0,
-    startTime: 0,
-  };
-
-  private minFPS = Number.MAX_SAFE_INTEGER;
-  private maxFPS = 0;
-  private averageFPS = 0;
-
-  private clearAnimationNumber = 0;
-
-  private measureLoop() {
-    // This looks weird but I'm avoiding a new closure
-    this.clearAnimationNumber = requestAnimationFrame(this.updateLoopCompute);
-  }
-
-  private updateLoopCompute = () => {
-    this.frameCount++;
-    const elapsedTime = (Date.now() - this.startTime) / 1000;
-    this.averageFPS = elapsedTime > 0 ? this.frameCount / elapsedTime : 0;
-
-    this.timeWindow.frameCount++;
-    const timeWindowElapsedTime =
-      (Date.now() - this.timeWindow.startTime) / 1000;
-    if (timeWindowElapsedTime >= 1) {
-      const timeWindowAverageFPS =
-        this.timeWindow.frameCount / timeWindowElapsedTime;
-      this.minFPS = Math.min(this.minFPS, timeWindowAverageFPS);
-      this.maxFPS = Math.max(this.maxFPS, timeWindowAverageFPS);
-      this.timeWindow.frameCount = 0;
-      this.timeWindow.startTime = Date.now();
-    }
-    this.measureLoop();
-  };
-
-  public startTracking() {
-    if (this.startTime !== 0) {
-      throw new Error(
-        "This FPS Monitor has already been run, please create a new instance"
-      );
-    }
-    this.startTime = Date.now();
-    this.timeWindow.startTime = Date.now();
-    this.measureLoop();
-  }
-
-  public stopAndGetData(): JSFPSResult {
-    cancelAnimationFrame(this.clearAnimationNumber);
-    if (this.minFPS === Number.MAX_SAFE_INTEGER) {
-      this.minFPS = this.averageFPS;
-      this.maxFPS = this.averageFPS;
-    }
-    return {
-      minFPS: roundToDecimalPlaces(this.minFPS, 1),
-      maxFPS: roundToDecimalPlaces(this.maxFPS, 1),
-      averageFPS: roundToDecimalPlaces(this.averageFPS, 1),
-    };
-  }
-}
-
-export interface JSFPSResult {
-  minFPS: number;
-  maxFPS: number;
-  averageFPS: number;
-}
+/**
+ * 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 { roundToDecimalPlaces } from "./roundToDecimalPlaces";
+
+/**
+ * Can be used to monitor JS thread performance
+ * Use startTracking() and stopAndGetData() to start and stop tracking
+ */
+export class JSFPSMonitor {
+  private startTime = 0;
+  private frameCount = 0;
+  private timeWindow = {
+    frameCount: 0,
+    startTime: 0,
+  };
+
+  private minFPS = Number.MAX_SAFE_INTEGER;
+  private maxFPS = 0;
+  private averageFPS = 0;
+
+  private clearAnimationNumber = 0;
+
+  private measureLoop() {
+    // This looks weird but I'm avoiding a new closure
+    this.clearAnimationNumber = requestAnimationFrame(this.updateLoopCompute);
+  }
+
+  private updateLoopCompute = () => {
+    this.frameCount++;
+    const elapsedTime = (Date.now() - this.startTime) / 1000;
+    this.averageFPS = elapsedTime > 0 ? this.frameCount / elapsedTime : 0;
+
+    this.timeWindow.frameCount++;
+    const timeWindowElapsedTime =
+      (Date.now() - this.timeWindow.startTime) / 1000;
+    if (timeWindowElapsedTime >= 1) {
+      const timeWindowAverageFPS =
+        this.timeWindow.frameCount / timeWindowElapsedTime;
+      this.minFPS = Math.min(this.minFPS, timeWindowAverageFPS);
+      this.maxFPS = Math.max(this.maxFPS, timeWindowAverageFPS);
+      this.timeWindow.frameCount = 0;
+      this.timeWindow.startTime = Date.now();
+    }
+    this.measureLoop();
+  };
+
+  public startTracking() {
+    if (this.startTime !== 0) {
+      throw new Error(
+        "This FPS Monitor has already been run, please create a new instance"
+      );
+    }
+    this.startTime = Date.now();
+    this.timeWindow.startTime = Date.now();
+    this.measureLoop();
+  }
+
+  public stopAndGetData(): JSFPSResult {
+    cancelAnimationFrame(this.clearAnimationNumber);
+    if (this.minFPS === Number.MAX_SAFE_INTEGER) {
+      this.minFPS = this.averageFPS;
+      this.maxFPS = this.averageFPS;
+    }
+    return {
+      minFPS: roundToDecimalPlaces(this.minFPS, 1),
+      maxFPS: roundToDecimalPlaces(this.maxFPS, 1),
+      averageFPS: roundToDecimalPlaces(this.averageFPS, 1),
+    };
+  }
+}
+
+export interface JSFPSResult {
+  minFPS: number;
+  maxFPS: number;
+  averageFPS: number;
+}

package/src/benchmark/roundToDecimalPlaces.ts

@@ -1,28 +1,28 @@
-/**
- * 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.
- */
-
-export function roundToDecimalPlaces(value: number, decimalPlaces: number) {
-  const multiplier = 10 ** decimalPlaces;
-  return Math.round(value * multiplier) / multiplier;
-}
+/**
+ * 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.
+ */
+
+export function roundToDecimalPlaces(value: number, decimalPlaces: number) {
+  const multiplier = 10 ** decimalPlaces;
+  return Math.round(value * multiplier) / multiplier;
+}