@react-native-ohos/flash-list 1.8.3 → 2.1.1-rc.1

package/dist/FlashListProps.js

@@ -1,32 +1,6 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RenderTargetOptions = void 0;
-exports.RenderTargetOptions = {
-    Cell: "Cell",
-    StickyHeader: "StickyHeader",
-    Measurement: "Measurement",
-};
+export const RenderTargetOptions = {
+    Cell: "Cell",
+    StickyHeader: "StickyHeader",
+    Measurement: "Measurement",
+};
 //# sourceMappingURL=FlashListProps.js.map

package/dist/FlashListProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"FlashListProps.js","sourceRoot":"","sources":["../src/FlashListProps.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AA6BU,QAAA,mBAAmB,GAAiC;IAC/D,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;CAC3B,CAAC"}
+{"version":3,"file":"FlashListProps.js","sourceRoot":"","sources":["../src/FlashListProps.ts"],"names":[],"mappings":"AA+BA,MAAM,CAAC,MAAM,mBAAmB,GAAiC;IAC/D,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;CAC3B,CAAC"}

package/dist/FlashListRef.d.ts

@@ -0,0 +1,305 @@
+import type { RVLayout } from "./recyclerview/layout-managers/LayoutManager";
+import { RecyclerViewProps } from "./recyclerview/RecyclerViewProps";
+import { CompatScroller } from "./recyclerview/components/CompatScroller";
+/**
+ * Base parameters for scrolling to the edges of the list.
+ */
+export interface ScrollToEdgeParams {
+    /** Whether the scroll should be animated */
+    animated?: boolean;
+}
+/**
+ * Parameters for scrolling to a specific position in the list.
+ * Extends ScrollToEdgeParams to include view positioning options.
+ */
+export interface ScrollToParams extends ScrollToEdgeParams {
+    /** Position of the target item relative to the viewport (0 = top, 0.5 = center, 1 = bottom) */
+    viewPosition?: number;
+    /** Additional offset to apply after viewPosition calculation */
+    viewOffset?: number;
+}
+/**
+ * Parameters for scrolling to a specific offset in the list.
+ * Used when you want to scroll to an exact pixel position.
+ */
+export interface ScrollToOffsetParams extends ScrollToParams {
+    /** The pixel offset to scroll to */
+    offset: number;
+    /**
+     * If true, the first item offset will not be added to the offset calculation.
+     * First offset represents header size or top padding.
+     */
+    skipFirstItemOffset?: boolean;
+}
+/**
+ * Parameters for scrolling to a specific index in the list.
+ * Used when you want to scroll to a specific item by its position in the data array.
+ */
+export interface ScrollToIndexParams extends ScrollToParams {
+    /** The index of the item to scroll to */
+    index: number;
+}
+/**
+ * Parameters for scrolling to a specific item in the list.
+ * Used when you want to scroll to a specific item by its data value.
+ */
+export interface ScrollToItemParams<T> extends ScrollToParams {
+    /** The item to scroll to */
+    item: T;
+}
+/**
+ * Interface for FlashList's ref object that provides imperative methods
+ * for controlling list behavior.
+ *
+ * Usage example:
+ * ```tsx
+ * const listRef = useRef<FlashListRef<ItemType>>(null);
+ *
+ * // Later in your component
+ * <FlashList
+ *   ref={listRef}
+ *   data={data}
+ *   renderItem={renderItem}
+ * />
+ *
+ * // Somewhere else in your component
+ * listRef.current?.scrollToIndex({ index: 5, animated: true });
+ * ```
+ */
+export interface FlashListRef<T> {
+    /**
+     * Get access to current props
+     */
+    props: RecyclerViewProps<T>;
+    /**
+     * Scrolls the list to a specific offset position.
+     *
+     * Use this method when you want precise control over the scroll position in pixels
+     * rather than by item index.
+     *
+     * @param params - Parameters for scrolling to offset
+     * @param params.offset - The pixel offset to scroll to
+     * @param params.animated - Whether the scroll should be animated (default: false)
+     * @param params.skipFirstItemOffset - If true, the first item offset (headers/padding)
+     *                                    will not be included in calculation (default: true)
+     *
+     * @example
+     * // Scroll to 200px from the top/left
+     * listRef.current?.scrollToOffset({ offset: 200, animated: true });
+     */
+    scrollToOffset: (params: ScrollToOffsetParams) => void;
+    /**
+     * Makes the scroll indicators flash momentarily.
+     *
+     * Useful to indicate to users that there is more content to scroll.
+     *
+     * @example
+     * listRef.current?.flashScrollIndicators();
+     */
+    flashScrollIndicators: () => void;
+    /**
+     * Returns the underlying native scroll view reference.
+     *
+     * Use this when you need direct access to the native scroll component.
+     * This is generally not recommended for regular use.
+     *
+     * @returns The native scroll view reference
+     */
+    getNativeScrollRef: () => CompatScroller | null;
+    /**
+     * Returns a reference to the scroll responder.
+     *
+     * Useful for more advanced scroll handling and integrations.
+     *
+     * @returns The scroll responder
+     */
+    getScrollResponder: CompatScroller["getScrollResponder"];
+    /**
+     * Returns the underlying scrollable node.
+     *
+     * Primarily used for platform-specific integrations.
+     *
+     * @returns The scrollable node
+     */
+    getScrollableNode: () => any;
+    /**
+     * Scrolls to the end of the list.
+     *
+     * @param params - Optional parameters for scrolling
+     * @param params.animated - Whether the scroll should be animated (default: false)
+     *
+     * @example
+     * // Animate scroll to the end of the list
+     * listRef.current?.scrollToEnd({ animated: true });
+     */
+    scrollToEnd: (params?: ScrollToEdgeParams) => void;
+    /**
+     * Scrolls to the top (or start) of the list.
+     *
+     * @param params - Optional parameters for scrolling
+     * @param params.animated - Whether the scroll should be animated (default: false)
+     *
+     * @example
+     * // Smoothly scroll to the top
+     * listRef.current?.scrollToTop({ animated: true });
+     */
+    scrollToTop: (params?: ScrollToEdgeParams) => void;
+    /**
+     * Scrolls to a specific index in the list.
+     *
+     * This is the most common method to scroll to a particular item.
+     *
+     * @param params - Parameters for scrolling to index
+     * @param params.index - The index of the item to scroll to
+     * @param params.animated - Whether the scroll should be animated (default: false)
+     * @param params.viewPosition - Position of the item within the visible area:
+     *                              0 = top/left, 0.5 = center, 1 = bottom/right (default: 0)
+     * @param params.viewOffset - Additional offset to apply after viewPosition calculation
+     *
+     * @returns A Promise that resolves when the scroll operation is complete
+     *
+     * @example
+     * // Scroll to the 5th item (index 4) and center it
+     * listRef.current?.scrollToIndex({
+     *   index: 4,
+     *   animated: true,
+     *   viewPosition: 0.5
+     * });
+     */
+    scrollToIndex: (params: ScrollToIndexParams) => Promise<void>;
+    /**
+     * Scrolls to a specific item in the list.
+     *
+     * Similar to scrollToIndex, but works with the item reference instead of its index.
+     * Useful when you have a reference to an item but don't know its index.
+     *
+     * @param params - Parameters for scrolling to item
+     * @param params.item - The item object to scroll to
+     * @param params.animated - Whether the scroll should be animated (default: false)
+     * @param params.viewPosition - Position of the item within the visible area:
+     *                              0 = top/left, 0.5 = center, 1 = bottom/right (default: 0)
+     * @param params.viewOffset - Additional offset to apply after viewPosition calculation
+     *
+     * @example
+     * // Scroll to a specific item
+     * const targetItem = data[10];
+     * listRef.current?.scrollToItem({
+     *   item: targetItem,
+     *   animated: true
+     * });
+     */
+    scrollToItem: (params: ScrollToItemParams<T>) => void;
+    /**
+     * Returns the offset of the first item (accounts for header/padding).
+     *
+     * Useful when implementing custom scroll behavior or calculating positions.
+     *
+     * @returns The pixel offset of the first item
+     */
+    getFirstItemOffset: () => number;
+    /**
+     * Returns the current viewport dimensions.
+     *
+     * @returns An object with width and height properties representing viewport size
+     */
+    getWindowSize: () => {
+        width: number;
+        height: number;
+    };
+    /**
+     * Returns the layout information for a specific item.
+     *
+     * Use this to get position and size information for an item at a given index.
+     *
+     * @param index - The index of the item to get layout information for
+     * @returns Layout information including x, y, width, and height
+     *
+     * @example
+     * const itemLayout = listRef.current?.getLayout(5);
+     * console.log(`Item 5 position: (${itemLayout.x}, ${itemLayout.y})`);
+     */
+    getLayout: (index: number) => RVLayout | undefined;
+    /**
+     * Returns the absolute last scroll offset.
+     *
+     * Useful for implementing custom scroll tracking functionality.
+     *
+     * @returns The last scroll offset in pixels
+     */
+    getAbsoluteLastScrollOffset: () => number;
+    /**
+     * Returns the dimensions of the child container.
+     *
+     * @returns An object with width and height properties
+     */
+    getChildContainerDimensions: () => {
+        width: number;
+        height: number;
+    };
+    /**
+     * Marks the list as having been interacted with.
+     *
+     * Call this method when you want to manually trigger the onViewableItemsChanged
+     * callback without an actual scroll event.
+     */
+    recordInteraction: () => void;
+    /**
+     * Returns the currently visible item indices.
+     *
+     * Use this to determine which items are currently visible to the user.
+     *
+     * @returns An object with startIndex and endIndex properties
+     *
+     * @example
+     * const { startIndex, endIndex } = listRef.current?.getVisibleIndices();
+     * console.log(`Visible items: ${startIndex} to ${endIndex}`);
+     */
+    computeVisibleIndices: () => {
+        startIndex: number;
+        endIndex: number;
+    };
+    /**
+     * Returns the index of the first visible item.
+     *
+     * Convenience method when you only need the first visible item.
+     *
+     * @returns The index of the first visible item
+     *
+     * @example
+     * const firstVisibleIndex = listRef.current?.getFirstVisibleIndex();
+     */
+    getFirstVisibleIndex: () => number;
+    /**
+     * Forces recalculation of viewable items (vieability callbacks).
+     *
+     * Call this after any operation that might affect item visibility but
+     * doesn't trigger a scroll event.
+     *
+     * @example
+     * // After manually changing item sizes
+     * listRef.current?.recomputeViewableItems();
+     */
+    recomputeViewableItems: () => void;
+    /**
+     * Disables item recycling in preparation for layout animations.
+     *
+     * Call this before performing layout animations to prevent visual glitches.
+     * Remember to reset disableRecycling after animations complete.
+     *
+     * @example
+     * // Before starting layout animations
+     * listRef.current?.prepareForLayoutAnimationRender();
+     */
+    prepareForLayoutAnimationRender: () => void;
+    /**
+     * Clears the layout cache on update.
+     * Call this when you want to clear the layout cache on update.
+     * Can be useful for carousals when orientation changes.
+     * This should be called before the render and not in an effect.
+     *
+     * @example
+     * listRef.current?.clearLayoutCacheOnUpdate();
+     */
+    clearLayoutCacheOnUpdate: () => void;
+}
+//# sourceMappingURL=FlashListRef.d.ts.map

package/dist/FlashListRef.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlashListRef.d.ts","sourceRoot":"","sources":["../src/FlashListRef.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8CAA8C,CAAC;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,+FAA+F;IAC/F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gEAAgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,cAAc;IACzD,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,CAAE,SAAQ,cAAc;IAC3D,4BAA4B;IAC5B,IAAI,EAAE,CAAC,CAAC;CACT;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B;;OAEG;IACH,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC5B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAEvD;;;;;;;OAOG;IACH,qBAAqB,EAAE,MAAM,IAAI,CAAC;IAElC;;;;;;;OAOG;IACH,kBAAkB,EAAE,MAAM,cAAc,GAAG,IAAI,CAAC;IAEhD;;;;;;OAMG;IACH,kBAAkB,EAAE,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAEzD;;;;;;OAMG;IACH,iBAAiB,EAAE,MAAM,GAAG,CAAC;IAE7B;;;;;;;;;OASG;IACH,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAEnD;;;;;;;;;OASG;IACH,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,aAAa,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAY,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAEtD;;;;;;OAMG;IACH,kBAAkB,EAAE,MAAM,MAAM,CAAC;IAEjC;;;;OAIG;IACH,aAAa,EAAE,MAAM;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAEvD;;;;;;;;;;;OAWG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,QAAQ,GAAG,SAAS,CAAC;IAEnD;;;;;;OAMG;IACH,2BAA2B,EAAE,MAAM,MAAM,CAAC;IAE1C;;;;OAIG;IACH,2BAA2B,EAAE,MAAM;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAErE;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,IAAI,CAAC;IAE9B;;;;;;;;;;OAUG;IACH,qBAAqB,EAAE,MAAM;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAEtE;;;;;;;;;OASG;IACH,oBAAoB,EAAE,MAAM,MAAM,CAAC;IAEnC;;;;;;;;;OASG;IACH,sBAAsB,EAAE,MAAM,IAAI,CAAC;IAEnC;;;;;;;;;OASG;IACH,+BAA+B,EAAE,MAAM,IAAI,CAAC;IAE5C;;;;;;;;OAQG;IACH,wBAAwB,EAAE,MAAM,IAAI,CAAC;CACtC"}

package/dist/FlashListRef.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=FlashListRef.js.map

package/dist/FlashListRef.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlashListRef.js","sourceRoot":"","sources":["../src/FlashListRef.ts"],"names":[],"mappings":""}

package/dist/benchmark/AutoScrollHelper.d.ts

@@ -1,41 +1,18 @@
-/**
- * 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 declare function autoScroll(scroll: (x: number, y: number, animated: boolean) => void, fromX: number, fromY: number, toX: number, toY: number, speedMultiplier?: number, cancellable?: Cancellable): Promise<boolean>;
-export declare class Cancellable {
-    cancel(): void;
-    isCancelled(): boolean;
-    _isCancelled: boolean;
-}
+/**
+ * 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 declare function autoScroll(scroll: (x: number, y: number, animated: boolean) => void, fromX: number, fromY: number, toX: number, toY: number, speedMultiplier?: number, cancellable?: Cancellable): Promise<boolean>;
+export declare class Cancellable {
+    cancel(): void;
+    isCancelled(): boolean;
+    _isCancelled: boolean;
+}
 //# sourceMappingURL=AutoScrollHelper.d.ts.map

package/dist/benchmark/AutoScrollHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AutoScrollHelper.d.ts","sourceRoot":"","sources":["../../src/benchmark/AutoScrollHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,EACzD,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,eAAe,SAAI,EACnB,WAAW,GAAE,WAA+B,GAC3C,OAAO,CAAC,OAAO,CAAC,CAsClB;AAED,qBAAa,WAAW;IACf,MAAM;IAIN,WAAW,IAAI,OAAO;IAItB,YAAY,UAAS;CAC7B"}
+{"version":3,"file":"AutoScrollHelper.d.ts","sourceRoot":"","sources":["../../src/benchmark/AutoScrollHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,KAAK,IAAI,EACzD,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,eAAe,SAAI,EACnB,WAAW,GAAE,WAA+B,GAC3C,OAAO,CAAC,OAAO,CAAC,CAsClB;AAED,qBAAa,WAAW;IACf,MAAM;IAIN,WAAW,IAAI,OAAO;IAItB,YAAY,UAAS;CAC7B"}

package/dist/benchmark/AutoScrollHelper.js

@@ -1,91 +1,60 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cancellable = exports.autoScroll = void 0;
-/**
- * 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
- */
-function autoScroll(scroll, fromX, fromY, toX, toY, speedMultiplier, cancellable) {
-    if (speedMultiplier === void 0) { speedMultiplier = 1; }
-    if (cancellable === void 0) { cancellable = new Cancellable(); }
-    return new Promise(function (resolve) {
-        scroll(fromX, fromY, false);
-        // Very fast scrolls on Android/iOS typically move content 7px every millisecond.
-        var incrementPerMs = 7 * speedMultiplier;
-        var directionMultiplierX = toX > fromX ? 1 : -1;
-        var directionMultiplierY = toY > fromY ? 1 : -1;
-        var comparatorX = toX > fromX ? Math.min : Math.max;
-        var comparatorY = toY > fromY ? Math.min : Math.max;
-        var startTime = Date.now();
-        var startX = fromX;
-        var startY = fromY;
-        // Computes the number of pixels to scroll in the given time
-        // Also invokes the scrollable to update the scroll position
-        var animationLoop = function () {
-            requestAnimationFrame(function () {
-                if (cancellable.isCancelled()) {
-                    resolve(false);
-                    return;
-                }
-                var currentTime = Date.now();
-                var timeElapsed = currentTime - startTime;
-                var 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();
-    });
-}
-exports.autoScroll = autoScroll;
-var Cancellable = /** @class */ (function () {
-    function Cancellable() {
-        this._isCancelled = false;
-    }
-    Cancellable.prototype.cancel = function () {
-        this._isCancelled = true;
-    };
-    Cancellable.prototype.isCancelled = function () {
-        return this._isCancelled;
-    };
-    return Cancellable;
-}());
-exports.Cancellable = Cancellable;
+/**
+ * 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, fromX, fromY, toX, toY, speedMultiplier = 1, cancellable = new Cancellable()) {
+    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 {
+    constructor() {
+        this._isCancelled = false;
+    }
+    cancel() {
+        this._isCancelled = true;
+    }
+    isCancelled() {
+        return this._isCancelled;
+    }
+}
 //# sourceMappingURL=AutoScrollHelper.js.map

package/dist/benchmark/AutoScrollHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"AutoScrollHelper.js","sourceRoot":"","sources":["../../src/benchmark/AutoScrollHelper.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AAEH;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,MAAyD,EACzD,KAAa,EACb,KAAa,EACb,GAAW,EACX,GAAW,EACX,eAAmB,EACnB,WAA4C;IAD5C,gCAAA,EAAA,mBAAmB;IACnB,4BAAA,EAAA,kBAA+B,WAAW,EAAE;IAE5C,OAAO,IAAI,OAAO,CAAC,UAAC,OAAO;QACzB,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC5B,iFAAiF;QACjF,IAAM,cAAc,GAAG,CAAC,GAAG,eAAe,CAAC;QAC3C,IAAM,oBAAoB,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,IAAM,oBAAoB,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,IAAM,WAAW,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACtD,IAAM,WAAW,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACtD,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,4DAA4D;QAC5D,4DAA4D;QAC5D,IAAM,aAAa,GAAG;YACpB,qBAAqB,CAAC;gBACpB,IAAI,WAAW,CAAC,WAAW,EAAE,EAAE;oBAC7B,OAAO,CAAC,KAAK,CAAC,CAAC;oBACf,OAAO;iBACR;gBACD,IAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,IAAM,WAAW,GAAG,WAAW,GAAG,SAAS,CAAC;gBAC5C,IAAM,eAAe,GAAG,cAAc,GAAG,WAAW,CAAC;gBACrD,MAAM,IAAI,eAAe,GAAG,oBAAoB,CAAC;gBACjD,MAAM,IAAI,eAAe,GAAG,oBAAoB,CAAC;gBACjD,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;gBAClE,SAAS,GAAG,WAAW,CAAC;gBACxB,IACE,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,GAAG;oBAChC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,GAAG,EAChC;oBACA,OAAO,aAAa,EAAE,CAAC;iBACxB;gBACD,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QACF,aAAa,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AA9CD,gCA8CC;AAED;IAAA;QASS,iBAAY,GAAG,KAAK,CAAC;IAC9B,CAAC;IATQ,4BAAM,GAAb;QACE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAEM,iCAAW,GAAlB;QACE,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAGH,kBAAC;AAAD,CAAC,AAVD,IAUC;AAVY,kCAAW"}
+{"version":3,"file":"AutoScrollHelper.js","sourceRoot":"","sources":["../../src/benchmark/AutoScrollHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,MAAyD,EACzD,KAAa,EACb,KAAa,EACb,GAAW,EACX,GAAW,EACX,eAAe,GAAG,CAAC,EACnB,cAA2B,IAAI,WAAW,EAAE;IAE5C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC5B,iFAAiF;QACjF,MAAM,cAAc,GAAG,CAAC,GAAG,eAAe,CAAC;QAC3C,MAAM,oBAAoB,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,oBAAoB,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,WAAW,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACtD,MAAM,WAAW,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACtD,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,4DAA4D;QAC5D,4DAA4D;QAC5D,MAAM,aAAa,GAAG,GAAG,EAAE;YACzB,qBAAqB,CAAC,GAAG,EAAE;gBACzB,IAAI,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC;oBAC9B,OAAO,CAAC,KAAK,CAAC,CAAC;oBACf,OAAO;gBACT,CAAC;gBACD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,MAAM,WAAW,GAAG,WAAW,GAAG,SAAS,CAAC;gBAC5C,MAAM,eAAe,GAAG,cAAc,GAAG,WAAW,CAAC;gBACrD,MAAM,IAAI,eAAe,GAAG,oBAAoB,CAAC;gBACjD,MAAM,IAAI,eAAe,GAAG,oBAAoB,CAAC;gBACjD,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;gBAClE,SAAS,GAAG,WAAW,CAAC;gBACxB,IACE,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,GAAG;oBAChC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,GAAG,EAChC,CAAC;oBACD,OAAO,aAAa,EAAE,CAAC;gBACzB,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QACF,aAAa,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,OAAO,WAAW;IAAxB;QASS,iBAAY,GAAG,KAAK,CAAC;IAC9B,CAAC;IATQ,MAAM;QACX,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;CAGF"}