@legendapp/list 3.3.3 → 3.3.5

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 3.3.5
+
+- Fix: Changing `dataKey` no longer leaves the new dataset invisible. #519
+- Fix: `maintainScrollAtEnd` stays pinned as newly inserted rows are measured, and scroll corrections preserve `anchoredEndSpace` padding. #520
+- Fix: Programmatic scrolls no longer throw in browsers, get lost when they replace unfinished initial scrolling, or stop working after a previous request is canceled. #518
+
+## 3.3.4
+
+- Feat: `getState().indexByKey(key)` looks up an item’s current index by key.
+- Feat: `anchoredEndSpace` now works with standard React Native `LegendList`, including horizontal and RTL lists, and stays accurate after content measurements change. It supports single-column lists only.
+- Fix: `maintainScrollAtEnd` continues following content growth unless the user scrolls away.
+- Fix: Changing `dataKey` no longer briefly displays stale rows from the previous dataset.
+- Fix: Initial scrolling and `scrollToIndex` correctly account for padding, direction, and final-item gaps.
+- Fix: Web content-container sizing remains correct when callers provide padding or `content-box` styles.
+- Fix: `useRecyclingEffect` and `useRecyclingState` no longer crash outside a `LegendList`. #498
+- Fix: Programmatic scrolls settle reliably when superseded, already aligned on iOS, or interrupted by unmounting. #508
+-
 ## 3.3.3
 
 - Fix: Row measurements are applied together in a batch, so item positions don't sometimes move after rendering.

package/animated.d.ts

@@ -455,11 +455,15 @@ interface ScrollToEndOptions {
     viewOffset?: number;
 }
 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 {
@@ -534,6 +538,7 @@ type LegendListState = {
     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;
@@ -719,6 +724,7 @@ interface ViewabilityConfig {
 }
 
 type LegendListPropsOverrides<ItemT, TItemType extends string | undefined> = Omit<LegendListPropsBase<ItemT, ScrollViewProps, TItemType>, "anchoredEndSpace" | "contentInsetEndAdjustment" | "onScroll" | "refScrollView" | "renderScrollComponent" | "ListHeaderComponentStyle" | "ListFooterComponentStyle"> & {
+    anchoredEndSpace?: AnchoredEndSpaceConfig;
     onScroll?: (event: NativeSyntheticEvent$1<NativeScrollEvent$1>) => void;
     refScrollView?: React.Ref<ScrollView>;
     renderScrollComponent?: (props: ScrollViewProps) => React.ReactElement<ScrollViewProps>;

package/keyboard-legacy.d.ts

@@ -97,6 +97,7 @@ type LegendListState = {
     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;

package/keyboard.d.ts

@@ -84,12 +84,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 LegendListAverageItemSize {
@@ -111,6 +115,7 @@ type LegendListState = {
     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;
@@ -245,9 +250,6 @@ type LegendListRef$1 = {
     setVisibleContentAnchorOffset(value: number | ((val: number) => number)): void;
 };
 
-interface AnchoredEndSpaceConfig extends Omit<AnchoredEndSpaceConfig$1, "includeInEndInset"> {
-}
-
 type LegendListRef = Omit<LegendListRef$1, "getAnimatableRef" | "getNativeScrollRef" | "getScrollResponder" | "reportContentInset"> & {
     getAnimatableRef(): React.ElementRef<typeof ScrollViewComponent>;
     getNativeScrollRef(): React.ElementRef<typeof ScrollViewComponent>;

package/keyboard.js

@@ -106,7 +106,6 @@ var KeyboardAwareLegendList = typedForwardRef(function KeyboardAwareLegendList2(
     }
     return {
       ...anchoredEndSpace,
-      includeInEndInset: true,
       onSizeChanged: (size) => {
         var _a;
         blankSpace.value = size;
@@ -149,6 +148,7 @@ var KeyboardAwareLegendList = typedForwardRef(function KeyboardAwareLegendList2(
     AnimatedLegendListInternal,
     {
       anchoredEndSpace: anchoredEndSpaceWithBlankSpace,
+      anchoredEndSpaceOwnerInternal: "scroll",
       ref: combinedRef,
       renderScrollComponent: memoList,
       ...rest

package/keyboard.mjs

@@ -85,7 +85,6 @@ var KeyboardAwareLegendList = typedForwardRef(function KeyboardAwareLegendList2(
     }
     return {
       ...anchoredEndSpace,
-      includeInEndInset: true,
       onSizeChanged: (size) => {
         var _a;
         blankSpace.value = size;
@@ -128,6 +127,7 @@ var KeyboardAwareLegendList = typedForwardRef(function KeyboardAwareLegendList2(
     AnimatedLegendListInternal,
     {
       anchoredEndSpace: anchoredEndSpaceWithBlankSpace,
+      anchoredEndSpaceOwnerInternal: "scroll",
       ref: combinedRef,
       renderScrollComponent: memoList,
       ...rest

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@legendapp/list",
-  "version": "3.3.3",
+  "version": "3.3.5",
   "description": "Legend List is a drop-in replacement for FlatList with much better performance and supporting dynamically sized items.",
   "sideEffects": false,
   "private": false,

package/react-native.d.ts

@@ -455,11 +455,15 @@ interface ScrollToEndOptions {
     viewOffset?: number;
 }
 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 {
@@ -534,6 +538,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;
@@ -745,6 +750,7 @@ interface ScrollIndexWithOffsetAndContentOffset extends ScrollIndexWithOffsetPos
 }
 
 type LegendListPropsOverrides<ItemT, TItemType extends string | undefined> = Omit<LegendListPropsBase<ItemT, ScrollViewProps, TItemType>, "anchoredEndSpace" | "contentInsetEndAdjustment" | "onScroll" | "refScrollView" | "renderScrollComponent" | "ListHeaderComponentStyle" | "ListFooterComponentStyle"> & {
+    anchoredEndSpace?: AnchoredEndSpaceConfig;
     onScroll?: (event: NativeSyntheticEvent$1<NativeScrollEvent$1>) => void;
     refScrollView?: React.Ref<ScrollView>;
     renderScrollComponent?: (props: ScrollViewProps) => React.ReactElement<ScrollViewProps>;
@@ -778,4 +784,4 @@ declare function useSyncLayout(): () => void;
 
 declare const LegendList: LegendListComponent;
 
-export { type AdaptiveRender, type AdaptiveRenderChangeReason, type AdaptiveRenderConfig, type AlwaysRenderConfig, type ColumnWrapperStyle, type Insets, type LayoutRectangle, LegendList, type LegendListAverageItemSize, type LegendListComponent, type LegendListMetrics, type LegendListProps, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type LegendListState, type MaintainScrollAtEndOnOptions, type MaintainScrollAtEndOptions, type MaintainVisibleContentPositionConfig, type NativeScrollEvent, type NativeSyntheticEvent, type OnViewableItemsChanged, type OnViewableItemsChangedInfo, type ScrollIndexWithOffset, type ScrollIndexWithOffsetAndContentOffset, type ScrollIndexWithOffsetPosition, type StickyHeaderConfig, type StyleProp, type ViewAmountToken, type ViewStyle, type ViewToken, type ViewabilityAmountCallback, type ViewabilityCallback, type ViewabilityConfig, type ViewabilityConfigCallbackPair, type ViewabilityConfigCallbackPairs, useAdaptiveRender, useAdaptiveRenderChange, useIsLastItem, useListScrollSize, useRecyclingEffect, useRecyclingState, useSyncLayout, useViewability, useViewabilityAmount };
+export { type AdaptiveRender, type AdaptiveRenderChangeReason, type AdaptiveRenderConfig, type AlwaysRenderConfig, type AnchoredEndSpaceConfig, type ColumnWrapperStyle, type Insets, type LayoutRectangle, LegendList, type LegendListAverageItemSize, type LegendListComponent, type LegendListMetrics, type LegendListProps, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type LegendListState, type MaintainScrollAtEndOnOptions, type MaintainScrollAtEndOptions, type MaintainVisibleContentPositionConfig, type NativeScrollEvent, type NativeSyntheticEvent, type OnViewableItemsChanged, type OnViewableItemsChangedInfo, type ScrollIndexWithOffset, type ScrollIndexWithOffsetAndContentOffset, type ScrollIndexWithOffsetPosition, type StickyHeaderConfig, type StyleProp, type ViewAmountToken, type ViewStyle, type ViewToken, type ViewabilityAmountCallback, type ViewabilityCallback, type ViewabilityConfig, type ViewabilityConfigCallbackPair, type ViewabilityConfigCallbackPairs, useAdaptiveRender, useAdaptiveRenderChange, useIsLastItem, useListScrollSize, useRecyclingEffect, useRecyclingState, useSyncLayout, useViewability, useViewabilityAmount };