UNPKG

@shopify/flash-list

Version:

FlashList is a more performant FlatList replacement

25 lines 1.35 kB
import { RecyclerViewManager } from "../RecyclerViewManager"; /** * Hook to track when the RecyclerView has loaded its items and notify when loading is complete. * Similar to FlashList's onLoad functionality, this hook tracks the time it takes to render * the initial set of items in the RecyclerView and provides performance metrics. * * @param recyclerViewManager - The RecyclerViewManager instance managing the list * @param onLoad - Optional callback function that will be called when the list has loaded with timing information * @returns Object containing isLoaded state indicating whether the list has completed initial rendering */ export declare const useOnListLoad: <T>(recyclerViewManager: RecyclerViewManager<T>, onLoad?: (info: { elapsedTimeInMs: number; }) => void) => { isLoaded: boolean; }; /** * Core hook that detects when a RecyclerView has completed its initial layout. * This hook monitors the RecyclerViewManager and triggers the provided callback * once the first layout is complete. * * @param recyclerViewManager - The RecyclerViewManager instance to monitor * @param onLoad - Callback function that will be called once when the first layout is complete */ export declare const useOnLoad: <T>(recyclerViewManager: RecyclerViewManager<T>, onLoad: () => void) => void; //# sourceMappingURL=useOnLoad.d.ts.map