@legendapp/list 3.0.0-beta.53 → 3.0.0-beta.55

package/animated.d.ts

@@ -154,7 +154,10 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      */
     extraData?: any;
     /**
-     * In case you have distinct item sizes, you can provide a function to get the size of an item.
+     * Optional per-item size estimate used before a row is measured.
+     *
+     * @deprecated Prefer a single `estimatedItemSize` for initial size hints, or `getFixedItemSize`
+     * when item sizes are known exactly.
      */
     getEstimatedItemSize?: (item: ItemT, index: number, type: TItemType) => number;
     /**
@@ -172,8 +175,9 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
         leadingItem: ItemT;
     }>;
     /**
-     * Ratio of initial container pool size to data length (e.g., 0.5 for half).
-     * @default 2
+     * Ratio used to size the initial recycled container pool.
+     * @deprecated The list now manages spare container capacity automatically.
+     * @default 3
      */
     initialContainerPoolRatio?: number | undefined;
     /**
@@ -224,6 +228,13 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * Style for the header component.
      */
     ListHeaderComponentStyle?: StyleProp<ViewStyle> | undefined;
+    /**
+     * Estimated height of the ListHeaderComponent. Provide this when the expected header height
+     * is known before layout so that only the items actually visible below the header are rendered
+     * on the initial frame, rather than a full screen's worth of items that are hidden behind it.
+     * The measured header size still replaces this value after layout.
+     */
+    estimatedHeaderSize?: number;
     /**
      * If true, auto-scrolls to end when new items are added.
      * Use an options object to opt into specific triggers and control whether that scroll is animated.
@@ -258,6 +269,12 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * @default 1
      */
     numColumns?: number;
+    /**
+     * Force RTL mode for this list instance.
+     * When undefined, uses React Native's global I18nManager.isRTL.
+     * @default undefined
+     */
+    rtl?: boolean;
     /**
      * Called when scrolling reaches the end within onEndReachedThreshold.
      */
@@ -354,12 +371,6 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * Array of item indices to use as snap points.
      */
     snapToIndices?: number[];
-    /**
-     * This will log a suggested estimatedItemSize.
-     * @required
-     * @default false
-     */
-    suggestEstimatedItemSize?: boolean;
     /**
      * Configuration for determining item viewability.
      */
@@ -448,6 +459,10 @@ interface LegendListMetrics {
     headerSize: number;
     footerSize: number;
 }
+interface LegendListAverageItemSize {
+    average: number;
+    count: number;
+}
 interface LegendListRenderItemProps<ItemT, TItemType extends string | number | undefined = string | number | undefined> {
     data: readonly ItemT[];
     extraData: any;
@@ -469,6 +484,7 @@ type LegendListState = {
     isEndReached: boolean;
     isStartReached: boolean;
     isWithinMaintainScrollAtEndThreshold: boolean;
+    getAverageItemSizes: () => Record<string, LegendListAverageItemSize>;
     listen: <T extends LegendListListenerType>(listenerType: T, callback: (value: ListenerTypeValueMap[T]) => void) => () => void;
     listenToPosition: (key: string, callback: (value: number) => void) => () => void;
     positionAtIndex: (index: number) => number;

package/index.d.ts

@@ -210,6 +210,7 @@ interface InternalState$1 {
         time: number;
     }>;
     scrollingTo?: InternalScrollTarget | undefined;
+    horizontalRTLScrollType?: "normal" | "inverted" | "negative";
     scrollLastCalculate?: number;
     scrollLength: number;
     scrollPending: number;
@@ -228,7 +229,6 @@ interface InternalState$1 {
     stickyContainers: Map<number, number>;
     timeouts: Set<number>;
     timeoutSetPaddingTop?: any;
-    timeoutSizeMessage: any;
     timeoutCheckFinishedScrollFallback?: any;
     totalSize: number;
     triggerCalculateItemsInView?: (params?: {
@@ -255,6 +255,7 @@ interface InternalState$1 {
         getFixedItemSize: LegendListPropsInternal["getFixedItemSize"];
         getItemType: LegendListPropsInternal["getItemType"];
         horizontal: boolean;
+        rtl?: boolean;
         initialContainerPoolRatio: number;
         itemsAreEqual: LegendListPropsInternal["itemsAreEqual"];
         keyExtractor: LegendListPropsInternal["keyExtractor"];
@@ -280,8 +281,9 @@ interface InternalState$1 {
         stickyIndicesArr: number[];
         stickyIndicesSet: Set<number>;
         stylePaddingBottom: number | undefined;
+        stylePaddingLeft: number | undefined;
+        stylePaddingRight: number | undefined;
         stylePaddingTop: number | undefined;
-        suggestEstimatedItemSize: boolean;
         useWindowScroll: boolean;
     };
 }
@@ -480,7 +482,10 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      */
     extraData?: any;
     /**
-     * In case you have distinct item sizes, you can provide a function to get the size of an item.
+     * Optional per-item size estimate used before a row is measured.
+     *
+     * @deprecated Prefer a single `estimatedItemSize` for initial size hints, or `getFixedItemSize`
+     * when item sizes are known exactly.
      */
     getEstimatedItemSize?: (item: ItemT, index: number, type: TItemType) => number;
     /**
@@ -498,8 +503,9 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
         leadingItem: ItemT;
     }>;
     /**
-     * Ratio of initial container pool size to data length (e.g., 0.5 for half).
-     * @default 2
+     * Ratio used to size the initial recycled container pool.
+     * @deprecated The list now manages spare container capacity automatically.
+     * @default 3
      */
     initialContainerPoolRatio?: number | undefined;
     /**
@@ -550,6 +556,13 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * Style for the header component.
      */
     ListHeaderComponentStyle?: StyleProp$1<ViewStyle$1> | undefined;
+    /**
+     * Estimated height of the ListHeaderComponent. Provide this when the expected header height
+     * is known before layout so that only the items actually visible below the header are rendered
+     * on the initial frame, rather than a full screen's worth of items that are hidden behind it.
+     * The measured header size still replaces this value after layout.
+     */
+    estimatedHeaderSize?: number;
     /**
      * If true, auto-scrolls to end when new items are added.
      * Use an options object to opt into specific triggers and control whether that scroll is animated.
@@ -584,6 +597,12 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * @default 1
      */
     numColumns?: number;
+    /**
+     * Force RTL mode for this list instance.
+     * When undefined, uses React Native's global I18nManager.isRTL.
+     * @default undefined
+     */
+    rtl?: boolean;
     /**
      * Called when scrolling reaches the end within onEndReachedThreshold.
      */
@@ -680,12 +699,6 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * Array of item indices to use as snap points.
      */
     snapToIndices?: number[];
-    /**
-     * This will log a suggested estimatedItemSize.
-     * @required
-     * @default false
-     */
-    suggestEstimatedItemSize?: boolean;
     /**
      * Configuration for determining item viewability.
      */
@@ -774,6 +787,10 @@ interface LegendListMetrics$1 {
     headerSize: number;
     footerSize: number;
 }
+interface LegendListAverageItemSize$1 {
+    average: number;
+    count: number;
+}
 interface LegendListRenderItemProps$1<ItemT, TItemType extends string | number | undefined = string | number | undefined> {
     data: readonly ItemT[];
     extraData: any;
@@ -795,6 +812,7 @@ type LegendListState$1 = {
     isEndReached: boolean;
     isStartReached: boolean;
     isWithinMaintainScrollAtEndThreshold: boolean;
+    getAverageItemSizes: () => Record<string, LegendListAverageItemSize$1>;
     listen: <T extends LegendListListenerType>(listenerType: T, callback: (value: ListenerTypeValueMap[T]) => void) => () => void;
     listenToPosition: (key: string, callback: (value: number) => void) => () => void;
     positionAtIndex: (index: number) => number;
@@ -1045,6 +1063,8 @@ type ColumnWrapperStyle = ColumnWrapperStyle$1;
 /** @deprecated Use `@legendapp/list/react-native` or `@legendapp/list/react` for strict typing */
 type LegendListMetrics = LegendListMetrics$1;
 /** @deprecated Use `@legendapp/list/react-native` or `@legendapp/list/react` for strict typing */
+type LegendListAverageItemSize = LegendListAverageItemSize$1;
+/** @deprecated Use `@legendapp/list/react-native` or `@legendapp/list/react` for strict typing */
 type ThresholdSnapshot = ThresholdSnapshot$1;
 /** @deprecated Use `@legendapp/list/react-native` or `@legendapp/list/react` for strict typing */
 type ScrollTarget = ScrollTarget$1;
@@ -1331,4 +1351,4 @@ declare function useSyncLayout(): () => void;
 /** @deprecated Use `@legendapp/list/react-native` or `@legendapp/list/react` for strict typing */
 declare const LegendList: LegendListComponent;
 
-export { type AccessibilityActionEvent, type AccessibilityRole, type AccessibilityState, type AccessibilityValue, type AlwaysRenderConfig, type AnchoredEndSpaceConfig, type BaseScrollViewProps, type ColorValue, type ColumnWrapperStyle, type GestureResponderEvent, type GetRenderedItem, type GetRenderedItemResult, type InitialScrollAnchor, type Insets, type InternalState, type LayoutChangeEvent, type LayoutRectangle, LegendList, type LegendListComponent, type LegendListMetrics, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type LegendListScrollerRef, type LegendListState, type LooseAccessibilityActionEvent, type LooseAccessibilityRole, type LooseAccessibilityState, type LooseAccessibilityValue, type LooseColorValue, type LooseGestureResponderEvent, type LoosePointerEvent, type LooseRefreshControlProps, type LooseRole, type LooseScrollViewProps, type MaintainScrollAtEndOnOptions, type MaintainScrollAtEndOptions, type MaintainVisibleContentPositionConfig, type MaintainVisibleContentPositionNormalized, type NativeScrollEvent, type NativeSyntheticEvent, type OnViewableItemsChanged, type OnViewableItemsChangedInfo, type PointProp, type PointerEvent, type RefreshControlProps, type Role, type ScrollEventTargetLike, type ScrollIndexWithOffset, type ScrollIndexWithOffsetAndContentOffset, type ScrollIndexWithOffsetPosition, type ScrollTarget, type ScrollViewPropsLoose, type ScrollableNodeLike, 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 };
+export { type AccessibilityActionEvent, type AccessibilityRole, type AccessibilityState, type AccessibilityValue, type AlwaysRenderConfig, type AnchoredEndSpaceConfig, type BaseScrollViewProps, type ColorValue, type ColumnWrapperStyle, type GestureResponderEvent, type GetRenderedItem, type GetRenderedItemResult, type InitialScrollAnchor, type Insets, type InternalState, type LayoutChangeEvent, type LayoutRectangle, LegendList, type LegendListAverageItemSize, type LegendListComponent, type LegendListMetrics, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type LegendListScrollerRef, type LegendListState, type LooseAccessibilityActionEvent, type LooseAccessibilityRole, type LooseAccessibilityState, type LooseAccessibilityValue, type LooseColorValue, type LooseGestureResponderEvent, type LoosePointerEvent, type LooseRefreshControlProps, type LooseRole, type LooseScrollViewProps, type MaintainScrollAtEndOnOptions, type MaintainScrollAtEndOptions, type MaintainVisibleContentPositionConfig, type MaintainVisibleContentPositionNormalized, type NativeScrollEvent, type NativeSyntheticEvent, type OnViewableItemsChanged, type OnViewableItemsChangedInfo, type PointProp, type PointerEvent, type RefreshControlProps, type Role, type ScrollEventTargetLike, type ScrollIndexWithOffset, type ScrollIndexWithOffsetAndContentOffset, type ScrollIndexWithOffsetPosition, type ScrollTarget, type ScrollViewPropsLoose, type ScrollableNodeLike, 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 };