@react-native-ohos/flash-list
Version:
FlashList is a more performant FlatList replacement
41 lines • 2.06 kB
TypeScript
/**
* 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;
}
//# sourceMappingURL=AutoScrollHelper.d.ts.map