@legendapp/list 3.0.0-beta.31 → 3.0.0-beta.33

package/{index.d.mts → list-react-native.d.ts}

@@ -1,10 +1,14 @@
 import * as React$1 from 'react';
-import { ComponentProps, Key, ReactNode, Dispatch, SetStateAction } from 'react';
-import { View, ScrollView, Animated, LayoutRectangle, Insets, ScrollViewProps, ScrollViewComponent, ScrollResponderMixin, StyleProp, ViewStyle, NativeSyntheticEvent, NativeScrollEvent } from 'react-native';
-import Reanimated from 'react-native-reanimated';
+import { Key, ReactNode, ReactElement, Dispatch, SetStateAction } from 'react';
+import { ScrollViewProps, NativeSyntheticEvent as NativeSyntheticEvent$1, NativeScrollEvent as NativeScrollEvent$1, ScrollView, StyleProp as StyleProp$1, ViewStyle as ViewStyle$1, ScrollViewComponent, ScrollResponderMixin, Insets as Insets$1, View } from 'react-native';
 
 type AnimatedValue = number;
 
+type LooseMeasureCallback = (x: number, y: number, width: number, height: number, pageX: number, pageY: number) => void;
+interface LooseView {
+    measure?: (callback: LooseMeasureCallback) => void;
+}
+
 type ListenerType = "activeStickyIndex" | "debugComputedScroll" | "debugRawScroll" | "extraData" | "footerSize" | "headerSize" | "lastItemKeys" | "lastPositionUpdate" | "maintainVisibleContentPosition" | "numColumns" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "scrollAdjust" | "scrollAdjustPending" | "scrollAdjustUserOffset" | "scrollSize" | "snapToOffsets" | "stylePaddingTop" | "totalSize" | `containerColumn${number}` | `containerSpan${number}` | `containerItemData${number}` | `containerItemKey${number}` | `containerPosition${number}` | `containerSticky${number}`;
 type LegendListListenerType = Extract<ListenerType, "activeStickyIndex" | "footerSize" | "headerSize" | "lastItemKeys" | "lastPositionUpdate" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "snapToOffsets" | "totalSize">;
 type ListenerTypeValueMap = {
@@ -65,7 +69,7 @@ interface StateContext {
     positionListeners: Map<string, Set<(value: any) => void>>;
     state: InternalState;
     values: Map<ListenerType, any>;
-    viewRefs: Map<number, React$1.RefObject<View>>;
+    viewRefs: Map<number, React$1.RefObject<LooseView>>;
 }
 
 declare class ScrollAdjustHandler {
@@ -85,6 +89,39 @@ type StylesAsSharedValue<Style> = {
     [key in keyof Style]: Style[key] | BaseSharedValue<Style[key]>;
 };
 
+interface Insets {
+    top: number;
+    left: number;
+    bottom: number;
+    right: number;
+}
+interface LayoutRectangle {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface NativeScrollEvent {
+    contentOffset: {
+        x: number;
+        y: number;
+    };
+    contentSize: {
+        width: number;
+        height: number;
+    };
+    layoutMeasurement: {
+        width: number;
+        height: number;
+    };
+    contentInset: Insets;
+    zoomScale: number;
+}
+interface NativeSyntheticEvent<T> {
+    nativeEvent: T;
+}
+type ViewStyle = Record<string, unknown>;
+type StyleProp<T> = T | T[] | null | undefined | false;
 type BaseScrollViewProps<TScrollView> = Omit<TScrollView, "contentOffset" | "maintainVisibleContentPosition" | "stickyHeaderIndices" | "removeClippedSubviews" | "children" | "onScroll">;
 interface DataModeProps<ItemT, TItemType extends string | undefined> {
     /**
@@ -311,7 +348,7 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
     /**
      * Ref to the underlying ScrollView component.
      */
-    refScrollView?: React.Ref<ScrollView>;
+    refScrollView?: React.Ref<any>;
     /**
      * If true, shows a refresh indicator.
      * @default false
@@ -322,7 +359,7 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * Note: When using `stickyHeaderIndices`, you must provide an Animated ScrollView component.
      * @default (props) => <ScrollView {...props} />
      */
-    renderScrollComponent?: (props: ScrollViewProps) => React.ReactElement<ScrollViewProps>;
+    renderScrollComponent?: (props: any) => React.ReactElement | null;
     /**
      * This will log a suggested estimatedItemSize.
      * @required
@@ -366,7 +403,8 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
     getFixedItemSize?: (item: ItemT, index: number, type: TItemType) => number | undefined;
     itemsAreEqual?: (itemPrevious: ItemT, item: ItemT, index: number, data: readonly ItemT[]) => boolean;
 }
-type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof ScrollView> | ComponentProps<typeof Animated.ScrollView> | ComponentProps<typeof Reanimated.ScrollView>, TItemType extends string | undefined = string | undefined> = BaseScrollViewProps<TScrollView> & LegendListSpecificProps<ItemT, TItemType> & (DataModeProps<ItemT, TItemType> | ChildrenModeProps);
+type LegendListPropsBase<ItemT, TScrollViewProps = Record<string, any>, TItemType extends string | undefined = string | undefined> = BaseScrollViewProps<TScrollViewProps> & LegendListSpecificProps<ItemT, TItemType> & (DataModeProps<ItemT, TItemType> | ChildrenModeProps);
+type LegendListPropsInternal = LegendListSpecificProps<any, string | undefined> & DataModeProps<any, string | undefined>;
 interface MaintainVisibleContentPositionConfig<ItemT = any> {
     data?: boolean;
     size?: boolean;
@@ -410,7 +448,6 @@ interface LegendListMetrics {
     headerSize: number;
     footerSize: number;
 }
-type LegendListProps<ItemT = any> = LegendListPropsBase<ItemT, ComponentProps<typeof ScrollView>>;
 interface ThresholdSnapshot {
     scrollPosition: number;
     contentSize?: number;
@@ -473,6 +510,12 @@ interface InternalState {
     loadStartTime: number;
     maintainingScrollAtEnd?: boolean;
     minIndexSizeChanged: number | undefined;
+    mvcpAnchorLock?: {
+        id: string;
+        position: number;
+        quietPasses: number;
+        expiresAt: number;
+    };
     contentInsetOverride?: Partial<Insets> | null;
     nativeContentInset?: Insets;
     nativeMarginTop: number;
@@ -482,8 +525,9 @@ interface InternalState {
     positions: Map<string, number>;
     previousData?: readonly unknown[];
     queuedCalculateItemsInView: number | undefined;
+    queuedMVCPRecalculate?: number;
     queuedInitialLayout?: boolean | undefined;
-    refScroller: React.RefObject<ScrollView>;
+    refScroller: React.RefObject<any>;
     scroll: number;
     scrollAdjustHandler: ScrollAdjustHandler;
     scrollForNextCalculateItemsInView: {
@@ -523,38 +567,40 @@ interface InternalState {
     viewabilityConfigCallbackPairs: ViewabilityConfigCallbackPairs<any> | undefined;
     props: {
         alignItemsAtEnd: boolean;
-        animatedProps: StylesAsSharedValue<ScrollViewProps>;
+        animatedProps: StylesAsSharedValue<Record<string, any>>;
         alwaysRender: AlwaysRenderConfig | undefined;
         alwaysRenderIndicesArr: number[];
         alwaysRenderIndicesSet: Set<number>;
         contentInset: Insets | undefined;
         data: readonly any[];
         dataVersion: Key | undefined;
+        drawDistance: number;
         estimatedItemSize: number | undefined;
-        getEstimatedItemSize: LegendListProps["getEstimatedItemSize"];
-        getFixedItemSize: LegendListProps["getFixedItemSize"];
-        getItemType: LegendListProps["getItemType"];
+        getEstimatedItemSize: LegendListPropsInternal["getEstimatedItemSize"];
+        getFixedItemSize: LegendListPropsInternal["getFixedItemSize"];
+        getItemType: LegendListPropsInternal["getItemType"];
         horizontal: boolean;
         initialContainerPoolRatio: number;
-        itemsAreEqual: LegendListProps["itemsAreEqual"];
-        keyExtractor: LegendListProps["keyExtractor"];
+        itemsAreEqual: LegendListPropsInternal["itemsAreEqual"];
+        keyExtractor: LegendListPropsInternal["keyExtractor"];
         maintainScrollAtEnd: boolean | MaintainScrollAtEndOptions;
         maintainScrollAtEndThreshold: number | undefined;
         maintainVisibleContentPosition: MaintainVisibleContentPositionNormalized;
         numColumns: number;
-        onEndReached: LegendListProps["onEndReached"];
+        onEndReached: LegendListPropsInternal["onEndReached"];
         onEndReachedThreshold: number | null | undefined;
-        onItemSizeChanged: LegendListProps["onItemSizeChanged"];
-        onLoad: LegendListProps["onLoad"];
-        onScroll: LegendListProps["onScroll"];
-        onStartReached: LegendListProps["onStartReached"];
+        onItemSizeChanged: LegendListPropsInternal["onItemSizeChanged"];
+        onLoad: LegendListPropsInternal["onLoad"];
+        onScroll: LegendListPropsInternal["onScroll"];
+        onStartReached: LegendListPropsInternal["onStartReached"];
         onStartReachedThreshold: number | null | undefined;
-        onStickyHeaderChange: LegendListProps["onStickyHeaderChange"];
-        overrideItemLayout: LegendListProps["overrideItemLayout"];
+        onStickyHeaderChange: LegendListPropsInternal["onStickyHeaderChange"];
+        overrideItemLayout: LegendListPropsInternal["overrideItemLayout"];
         recycleItems: boolean;
-        renderItem: LegendListProps["renderItem"];
-        scrollBuffer: number;
+        renderItem: LegendListPropsInternal["renderItem"];
+        scrollBuffer?: number;
         snapToIndices: number[] | undefined;
+        stickyPositionComponentInternal: React.ComponentType<any> | undefined;
         stickyIndicesArr: number[];
         stickyIndicesSet: Set<number>;
         stylePaddingBottom: number | undefined;
@@ -576,11 +622,11 @@ interface LegendListRenderItemProps<ItemT, TItemType extends string | number | u
     item: ItemT;
     type: TItemType;
 }
-type LegendListState = {
+type LegendListState$1 = {
     activeStickyIndex: number;
     contentLength: number;
     data: readonly any[];
-    elementAtIndex: (index: number) => View | null | undefined;
+    elementAtIndex: (index: number) => any;
     end: number;
     endBuffered: number;
     isAtEnd: boolean;
@@ -597,7 +643,7 @@ type LegendListState = {
     start: number;
     startBuffered: number;
 };
-type LegendListRef = {
+type LegendListRef$1 = {
     /**
      * Displays the scroll indicators momentarily.
      */
@@ -605,7 +651,7 @@ type LegendListRef = {
     /**
      * Returns the native ScrollView component reference.
      */
-    getNativeScrollRef(): React.ElementRef<typeof ScrollViewComponent>;
+    getNativeScrollRef(): any;
     /**
      * Returns the scroll responder instance for handling scroll events.
      */
@@ -613,11 +659,11 @@ type LegendListRef = {
     /**
      * Returns the ScrollResponderMixin for advanced scroll handling.
      */
-    getScrollResponder(): ScrollResponderMixin;
+    getScrollResponder(): any;
     /**
      * Returns the internal state of the scroll virtualization.
      */
-    getState(): LegendListState;
+    getState(): LegendListState$1;
     /**
      * Scrolls a specific index into view.
      * @param params - Parameters for scrolling.
@@ -697,6 +743,14 @@ type LegendListRef = {
      * @param enabled - If true, scroll processing is enabled.
      */
     setScrollProcessingEnabled(enabled: boolean): void;
+    /**
+     * Clears internal virtualization caches.
+     * @param options - Cache clearing options.
+     * @param options.mode - `sizes` clears measurement caches. `full` also clears key/position caches.
+     */
+    clearCaches(options?: {
+        mode?: "sizes" | "full";
+    }): void;
     /**
      * Reports an externally measured content inset. Pass null/undefined to clear.
      * Values are merged on top of props/animated/native insets.
@@ -792,9 +846,23 @@ type GetRenderedItemResult<ItemT> = {
 };
 type GetRenderedItem = (key: string) => GetRenderedItemResult<any> | null;
 
-declare const LegendList: (<T>(props: LegendListProps<T> & React$1.RefAttributes<LegendListRef>) => React$1.ReactNode) & {
-    displayName?: string;
+type LegendListPropsOverrides<ItemT, TItemType extends string | undefined> = Omit<LegendListPropsBase<ItemT, ScrollViewProps, TItemType>, "onScroll" | "refScrollView" | "renderScrollComponent" | "ListHeaderComponentStyle" | "ListFooterComponentStyle"> & {
+    onScroll?: (event: NativeSyntheticEvent$1<NativeScrollEvent$1>) => void;
+    refScrollView?: React.Ref<ScrollView>;
+    renderScrollComponent?: (props: ScrollViewProps) => ReactElement<ScrollViewProps>;
+    ListHeaderComponentStyle?: StyleProp$1<ViewStyle$1> | undefined;
+    ListFooterComponentStyle?: StyleProp$1<ViewStyle$1> | undefined;
+};
+type LegendListProps<ItemT = any, TItemType extends string | undefined = string | undefined> = LegendListPropsOverrides<ItemT, TItemType>;
+type LegendListRef = Omit<LegendListRef$1, "getNativeScrollRef" | "getScrollResponder" | "reportContentInset"> & {
+    getNativeScrollRef(): React.ElementRef<typeof ScrollViewComponent>;
+    getScrollResponder(): ScrollResponderMixin;
+    reportContentInset(inset?: Partial<Insets$1> | null): void;
 };
+type LegendListState = Omit<LegendListState$1, "elementAtIndex"> & {
+    elementAtIndex: (index: number) => View | null | undefined;
+};
+type LegendListComponent = <ItemT = any>(props: LegendListProps<ItemT> & React.RefAttributes<LegendListRef>) => React.ReactElement | null;
 
 declare function useViewability<ItemT = any>(callback: ViewabilityCallback<ItemT>, configId?: string): void;
 declare function useViewabilityAmount<ItemT = any>(callback: ViewabilityAmountCallback<ItemT>): void;
@@ -807,4 +875,6 @@ declare function useListScrollSize(): {
 };
 declare function useSyncLayout(): () => void;
 
-export { type AlwaysRenderConfig, type ColumnWrapperStyle, type GetRenderedItem, type GetRenderedItemResult, type InitialScrollAnchor, type InternalState, LegendList, type LegendListMetrics, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type LegendListState, type MaintainScrollAtEndOptions, type MaintainVisibleContentPositionConfig, type MaintainVisibleContentPositionNormalized, type OnViewableItemsChanged, type ScrollIndexWithOffset, type ScrollIndexWithOffsetAndContentOffset, type ScrollIndexWithOffsetPosition, type ScrollTarget, type StickyHeaderConfig, type ThresholdSnapshot, type TypedForwardRef, type TypedMemo, type ViewAmountToken, type ViewToken, type ViewabilityAmountCallback, type ViewabilityCallback, type ViewabilityConfig, type ViewabilityConfigCallbackPair, type ViewabilityConfigCallbackPairs, type ViewableRange, typedForwardRef, typedMemo, useIsLastItem, useListScrollSize, useRecyclingEffect, useRecyclingState, useSyncLayout, useViewability, useViewabilityAmount };
+declare const LegendList: LegendListComponent;
+
+export { type AlwaysRenderConfig, type BaseScrollViewProps, type ColumnWrapperStyle, type GetRenderedItem, type GetRenderedItemResult, type InitialScrollAnchor, type Insets, type InternalState, type LayoutRectangle, LegendList, type LegendListComponent, type LegendListMetrics, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type LegendListState, type MaintainScrollAtEndOptions, type MaintainVisibleContentPositionConfig, type MaintainVisibleContentPositionNormalized, type NativeScrollEvent, type NativeSyntheticEvent, type OnViewableItemsChanged, type ScrollIndexWithOffset, type ScrollIndexWithOffsetAndContentOffset, type ScrollIndexWithOffsetPosition, type ScrollTarget, type StickyHeaderConfig, type StyleProp, type ThresholdSnapshot, type TypedForwardRef, type TypedMemo, type ViewAmountToken, type ViewStyle, type ViewToken, type ViewabilityAmountCallback, type ViewabilityCallback, type ViewabilityConfig, type ViewabilityConfigCallbackPair, type ViewabilityConfigCallbackPairs, type ViewableRange, typedForwardRef, typedMemo, useIsLastItem, useListScrollSize, useRecyclingEffect, useRecyclingState, useSyncLayout, useViewability, useViewabilityAmount };