@legendapp/list 3.3.2 → 3.3.4

package/react.d.ts

@@ -31,12 +31,13 @@ interface MaintainVisibleContentPositionNormalized<ItemT = any> {
     shouldRestorePosition?: (item: ItemT, index: number, data: readonly ItemT[]) => boolean;
 }
 
-type ListenerType = "activeStickyIndex" | "alignItemsAtEndPadding" | "anchoredEndSpaceSize" | "debugComputedScroll" | "debugRawScroll" | "extraData" | "footerSize" | "headerSize" | "lastItemKeys" | "lastPositionUpdate" | "maintainVisibleContentPosition" | "numColumns" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "scrollAdjust" | "scrollAdjustPending" | "scrollAdjustUserOffset" | "scrollSize" | "snapToOffsets" | "stylePaddingTop" | "totalSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | "adaptiveRender" | `containerColumn${number}` | `containerSpan${number}` | `containerItemData${number}` | `containerItemInfo${number}` | `containerItemKey${number}` | `containerPosition${number}` | `containerSticky${number}`;
+type ListenerType = "activeStickyIndex" | "alignItemsAtEndPadding" | "anchoredEndSpaceSize" | "containerLayoutEpoch" | "debugComputedScroll" | "debugRawScroll" | "extraData" | "footerSize" | "headerSize" | "lastItemKeys" | "lastPositionUpdate" | "maintainVisibleContentPosition" | "numColumns" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "scrollAdjust" | "scrollAdjustPending" | "scrollAdjustUserOffset" | "scrollSize" | "snapToOffsets" | "stylePaddingTop" | "totalSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | "adaptiveRender" | `containerColumn${number}` | `containerSpan${number}` | `containerItemData${number}` | `containerItemIndex${number}` | `containerItemKey${number}` | `containerPosition${number}` | `containerSticky${number}`;
 type LegendListListenerType = Extract<ListenerType, "activeStickyIndex" | "anchoredEndSpaceSize" | "footerSize" | "headerSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | "adaptiveRender" | "lastItemKeys" | "lastPositionUpdate" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "snapToOffsets" | "totalSize">;
 type ListenerTypeValueMap = {
     activeStickyIndex: number;
     alignItemsAtEndPadding: number;
     anchoredEndSpaceSize: number;
+    containerLayoutEpoch: number;
     animatedScrollY: any;
     debugComputedScroll: number;
     debugRawScroll: number;
@@ -72,7 +73,7 @@ type ListenerTypeValueMap = {
 } & {
     [K in ListenerType as K extends `containerItemData${number}` ? K : never]: any;
 } & {
-    [K in ListenerType as K extends `containerItemInfo${number}` ? K : never]: ContainerItemInfo;
+    [K in ListenerType as K extends `containerItemIndex${number}` ? K : never]: number;
 } & {
     [K in ListenerType as K extends `containerPosition${number}` ? K : never]: number;
 } & {
@@ -82,11 +83,6 @@ type ListenerTypeValueMap = {
 } & {
     [K in ListenerType as K extends `containerSticky${number}` ? K : never]: boolean;
 };
-interface ContainerItemInfo {
-    index: number;
-    itemKey: string;
-    value: any;
-}
 
 interface Insets {
     top: number;
@@ -314,7 +310,7 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
     /**
      * Keeps an item visually anchored to the start by adding trailing space when the content below it underflows.
      */
-    anchoredEndSpace?: AnchoredEndSpaceConfig$1;
+    anchoredEndSpace?: AnchoredEndSpaceConfig;
     /**
      * Adjusts the effective end content inset for web lists without replacing the base contentInset.
      * The adjustment is also rendered as real content padding so the browser scroll range includes it.
@@ -481,12 +477,16 @@ interface ScrollToEndOptions {
     animated?: boolean;
     viewOffset?: number;
 }
-interface AnchoredEndSpaceConfig$1 {
+interface AnchoredEndSpaceConfig {
+    /** Index of the item whose row should remain anchored when trailing space is added. */
     anchorIndex: number;
+    /** Desired distance from the viewport's start edge to the anchored row. */
     anchorOffset?: number;
+    /** Optional cap for the anchor item's contribution to its row size. */
     anchorMaxSize?: number;
-    includeInEndInset?: boolean;
+    /** Called whenever the resolved trailing space changes. */
     onSizeChanged?: (size: number) => void;
+    /** Called once the anchor and every row after it have authoritative sizes. */
     onReady?: (info: AnchoredEndSpaceReadyInfo) => void;
 }
 interface StickyHeaderConfig {
@@ -561,6 +561,7 @@ type LegendListState$1 = {
     isStartReached: boolean;
     isWithinMaintainScrollAtEndThreshold: boolean;
     getAverageItemSizes: () => Record<string, LegendListAverageItemSize>;
+    indexByKey: (key: string) => number | undefined;
     listen: <T extends LegendListListenerType>(listenerType: T, callback: (value: ListenerTypeValueMap[T]) => void) => () => void;
     listenToPosition: (key: string, callback: (value: number) => void) => () => void;
     positionAtIndex: (index: number) => number;
@@ -590,6 +591,10 @@ type LegendListRef$1 = {
      * Returns the native ScrollView component reference.
      */
     getNativeScrollRef(): any;
+    /**
+     * Returns the underlying animatable scroll component reference.
+     */
+    getAnimatableRef(): any;
     /**
      * Returns the scroll responder instance for handling scroll events.
      */
@@ -789,6 +794,7 @@ interface LooseScrollViewProps {
     onMomentumScrollBegin?: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
     onMomentumScrollEnd?: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
     onScroll?: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    onScrollBeginDrag?: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
     refreshControl?: ReactElement | null;
     removeClippedSubviews?: boolean;
     scrollEventThrottle?: number;
@@ -798,9 +804,7 @@ interface LooseScrollViewProps {
     style?: StyleProp<ViewStyle>;
 }
 
-interface AnchoredEndSpaceConfig extends Omit<AnchoredEndSpaceConfig$1, "includeInEndInset"> {
-}
-type ScrollViewPropsWeb = Omit<LooseScrollViewProps, "style" | "contentContainerStyle" | "onScroll" | "onLayout" | "onMomentumScrollBegin" | "onMomentumScrollEnd" | "pagingEnabled" | "snapToInterval"> & Omit<HTMLAttributes<HTMLDivElement>, "onScroll" | "onLayout" | "style"> & {
+type ScrollViewPropsWeb = Omit<LooseScrollViewProps, "style" | "contentContainerStyle" | "onScroll" | "onLayout" | "onMomentumScrollBegin" | "onMomentumScrollEnd" | "onScrollBeginDrag" | "pagingEnabled" | "snapToInterval"> & Omit<HTMLAttributes<HTMLDivElement>, "onScroll" | "onLayout" | "style"> & {
     style?: CSSProperties;
     contentContainerClassName?: string;
     contentContainerStyle?: CSSProperties;
@@ -814,7 +818,8 @@ type LegendListPropsOverrides<ItemT, TItemType extends string | undefined> = Omi
     ListFooterComponentStyle?: CSSProperties | undefined;
 };
 type LegendListProps<ItemT = any, TItemType extends string | undefined = string | undefined> = LegendListPropsOverrides<ItemT, TItemType>;
-type LegendListRef = Omit<LegendListRef$1, "getNativeScrollRef" | "getScrollableNode" | "getScrollResponder"> & {
+type LegendListRef = Omit<LegendListRef$1, "getAnimatableRef" | "getNativeScrollRef" | "getScrollableNode" | "getScrollResponder"> & {
+    getAnimatableRef(): HTMLElement | ScrollViewMethods;
     getNativeScrollRef(): HTMLElement | ScrollViewMethods;
     getScrollableNode(): HTMLElement;
     getScrollResponder(): HTMLElement | null;