@legendapp/list 3.0.0-beta.40 → 3.0.0-beta.41

package/README.md

@@ -26,7 +26,7 @@ Beyond standard `FlatList` capabilities:
 *   `recycleItems`: (boolean) Toggles item component recycling.
     *   `true`: Reuses item components for optimal performance. Be cautious if your item components contain local state, as it might be reused unexpectedly.
     *   `false` (default): Creates new item components every time. Less performant but safer if items have complex internal state.
-*   `maintainScrollAtEnd`: (boolean) If `true` and the user is scrolled near the bottom (within `maintainScrollAtEndThreshold * screen height`), the list automatically scrolls to the end when items are added or heights change. Useful for chat interfaces.
+*   `maintainScrollAtEnd`: Keeps the list pinned to the tail when the user is already near the end (within `maintainScrollAtEndThreshold * screen height`). Pass `true` for all triggers, or `{ animated?: boolean, on?: { dataChange?: boolean, layout?: boolean, itemLayout?: boolean } }`; if `on` is omitted, the object form also enables all triggers.
 *   `maintainVisibleContentPosition`: Keeps visible content steady during size/layout changes while scrolling up or when items resize above the viewport (default). Pass `true` or `{ data: true }` to also anchor during data updates; pass `false` to disable; pass `{ size: false }` to opt out of scroll-time stabilization.
 *   `alignItemsAtEnd`: (boolean) Useful for chat UIs, content smaller than the View will be aligned to the bottom of the list.
 

package/animated.d.ts

@@ -210,6 +210,7 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
     ListHeaderComponentStyle?: StyleProp<ViewStyle> | undefined;
     /**
      * 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.
      * @default false
      */
     maintainScrollAtEnd?: boolean | MaintainScrollAtEndOptions;
@@ -387,10 +388,22 @@ interface AlwaysRenderConfig {
     indices?: number[];
     keys?: string[];
 }
+interface MaintainScrollAtEndOnOptions {
+    dataChange?: boolean;
+    itemLayout?: boolean;
+    layout?: boolean;
+}
 interface MaintainScrollAtEndOptions {
-    onLayout?: boolean;
-    onItemLayout?: boolean;
-    onDataChange?: boolean;
+    /**
+     * Whether maintainScrollAtEnd should animate when it scrolls to the end.
+     */
+    animated?: boolean;
+    /**
+     * Which events should keep the list pinned to the end.
+     * - If omitted, object values default to all triggers.
+     * - If provided, only the keys set to `true` are enabled.
+     */
+    on?: MaintainScrollAtEndOnOptions;
 }
 interface ColumnWrapperStyle {
     rowGap?: number;

package/index.d.ts

@@ -283,6 +283,7 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
     ListHeaderComponentStyle?: StyleProp$1<ViewStyle$1> | undefined;
     /**
      * 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.
      * @default false
      */
     maintainScrollAtEnd?: boolean | MaintainScrollAtEndOptions$1;
@@ -461,10 +462,22 @@ interface AlwaysRenderConfig$1 {
     indices?: number[];
     keys?: string[];
 }
+interface MaintainScrollAtEndOnOptions$1 {
+    dataChange?: boolean;
+    itemLayout?: boolean;
+    layout?: boolean;
+}
 interface MaintainScrollAtEndOptions$1 {
-    onLayout?: boolean;
-    onItemLayout?: boolean;
-    onDataChange?: boolean;
+    /**
+     * Whether maintainScrollAtEnd should animate when it scrolls to the end.
+     */
+    animated?: boolean;
+    /**
+     * Which events should keep the list pinned to the end.
+     * - If omitted, object values default to all triggers.
+     * - If provided, only the keys set to `true` are enabled.
+     */
+    on?: MaintainScrollAtEndOnOptions$1;
 }
 interface ColumnWrapperStyle$1 {
     rowGap?: number;
@@ -488,6 +501,7 @@ interface ScrollTarget$1 {
     itemSize?: number;
     offset: number;
     precomputedWithViewOffset?: boolean;
+    targetOffset?: number;
     viewOffset?: number;
     viewPosition?: number;
 }
@@ -525,7 +539,18 @@ interface InternalState$1 {
     ignoreScrollFromMVCPTimeout?: any;
     indexByKey: Map<string, number>;
     initialAnchor?: InitialScrollAnchor$1;
+    initialNativeScrollWatchdog?: {
+        startScroll: number;
+        targetOffset: number;
+    };
+    initialScrollLastDidFinish: boolean;
+    initialScrollLastTarget: ScrollIndexWithOffsetAndContentOffset$1 | undefined;
+    initialScrollLastTargetUsesOffset: boolean;
+    initialScrollPreviousDataLength: number;
+    initialScrollRetryLastLength: number | undefined;
+    initialScrollRetryWindowUntil: number;
     initialScroll: ScrollIndexWithOffsetAndContentOffset$1 | undefined;
+    initialScrollUsesOffset: boolean;
     isAtEnd: boolean;
     isAtStart: boolean;
     isEndReached: boolean | null;
@@ -549,6 +574,14 @@ interface InternalState$1 {
     nativeMarginTop: number;
     needsOtherAxisSize?: boolean;
     otherAxisSize?: number;
+    pendingNativeMVCPAdjust?: {
+        amount: number;
+        closestDistanceToClamp: number;
+        hasApproachedClamp: boolean;
+        manualApplied: number;
+        startScroll: number;
+    };
+    pendingMaintainScrollAtEnd?: boolean;
     pendingTotalSize?: number;
     pendingScrollResolve?: (() => void) | undefined;
     positions: Array<number | undefined>;
@@ -613,7 +646,7 @@ interface InternalState$1 {
         initialContainerPoolRatio: number;
         itemsAreEqual: LegendListPropsInternal["itemsAreEqual"];
         keyExtractor: LegendListPropsInternal["keyExtractor"];
-        maintainScrollAtEnd: boolean | MaintainScrollAtEndOptions$1;
+        maintainScrollAtEnd: MaintainScrollAtEndNormalized | undefined;
         maintainScrollAtEndThreshold: number | undefined;
         maintainVisibleContentPosition: MaintainVisibleContentPositionNormalized$1;
         numColumns: number;
@@ -911,6 +944,8 @@ type StickyHeaderConfig = StickyHeaderConfig$1;
 /** @deprecated Use `@legendapp/list/react-native` or `@legendapp/list/react` for strict typing */
 type AlwaysRenderConfig = AlwaysRenderConfig$1;
 /** @deprecated Use `@legendapp/list/react-native` or `@legendapp/list/react` for strict typing */
+type MaintainScrollAtEndOnOptions = MaintainScrollAtEndOnOptions$1;
+/** @deprecated Use `@legendapp/list/react-native` or `@legendapp/list/react` for strict typing */
 type MaintainScrollAtEndOptions = MaintainScrollAtEndOptions$1;
 /** @deprecated Use `@legendapp/list/react-native` or `@legendapp/list/react` for strict typing */
 type ColumnWrapperStyle = ColumnWrapperStyle$1;
@@ -1201,4 +1236,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 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 MaintainScrollAtEndOptions, type MaintainVisibleContentPositionConfig, type MaintainVisibleContentPositionNormalized, type NativeScrollEvent, type NativeSyntheticEvent, type OnViewableItemsChanged, 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 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 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 };