@legendapp/list 2.0.8 → 2.0.10

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 2.0.10
+- Feat: Add onStickyHeaderChange callback for sticky headers
+- Fix: Items with a falsy value like 0 were not rendering
+- Fix: Column positions sometimes not calculating correctly
+- Perf: updateItemsPositions was not breaking early sometimes
+- Perf: Changed idCache to be an array instead of a Map for better performance
+- Perf: Speed up container reuse lookups
+
+## 2.0.9
+- Fix: Improve initialScrollIndex accuracy and reliability
+
 ## 2.0.8
 - Fix: Data changing sometimes left blank spaces because it was ignoring scroll
 - Fix: Toggling between empty and non-empty causing maintainVisibleContentPosition issues

package/index.d.mts

@@ -5,6 +5,7 @@ import Animated$1 from 'react-native-reanimated';
 
 type ListenerType = "numContainers" | "numContainersPooled" | `containerItemKey${number}` | `containerItemData${number}` | `containerPosition${number}` | `containerColumn${number}` | `containerSticky${number}` | `containerStickyOffset${number}` | "containersDidLayout" | "extraData" | "numColumns" | "lastItemKeys" | "totalSize" | "alignItemsPaddingTop" | "stylePaddingTop" | "scrollAdjust" | "scrollAdjustUserOffset" | "headerSize" | "footerSize" | "maintainVisibleContentPosition" | "debugRawScroll" | "debugComputedScroll" | "otherAxisSize" | "snapToOffsets" | "scrollSize";
 interface StateContext {
+    internalState: InternalState | undefined;
     listeners: Map<ListenerType, Set<(value: any) => void>>;
     values: Map<ListenerType, any>;
     mapViewabilityCallbacks: Map<string, ViewabilityCallback>;
@@ -208,6 +209,13 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * @default 0.5
      */
     onStartReachedThreshold?: number | null | undefined;
+    /**
+     * Called when the sticky header changes.
+    */
+    onStickyHeaderChange?: (info: {
+        index: number;
+        item: any;
+    }) => void;
     /**
      * Called when the viewability of items changes.
      */
@@ -315,7 +323,7 @@ interface InternalState {
     timeoutSizeMessage: any;
     nativeMarginTop: number;
     indexByKey: Map<string, number>;
-    idCache: Map<number, string>;
+    idCache: string[];
     viewabilityConfigCallbackPairs: ViewabilityConfigCallbackPairs<any> | undefined;
     scrollHistory: Array<{
         scroll: number;
@@ -344,6 +352,7 @@ interface InternalState {
         viewOffset?: number;
         viewPosition?: number;
         animated?: boolean;
+        isInitialScroll?: boolean;
     } | undefined;
     needsOtherAxisSize?: boolean;
     averageSizes: Record<string, {
@@ -378,6 +387,7 @@ interface InternalState {
         onScroll: LegendListProps["onScroll"];
         onStartReached: LegendListProps["onStartReached"];
         onStartReachedThreshold: number | null | undefined;
+        onStickyHeaderChange: LegendListProps["onStickyHeaderChange"];
         recycleItems: boolean;
         suggestEstimatedItemSize: boolean;
         stylePaddingBottom: number | undefined;
@@ -540,7 +550,7 @@ interface ViewAmountToken<ItemT = any> extends ViewToken<ItemT> {
     percentOfScroller: number;
     scrollSize: number;
 }
-interface ViewabilityConfigCallbackPair<ItemT> {
+interface ViewabilityConfigCallbackPair<ItemT = any> {
     viewabilityConfig: ViewabilityConfig;
     onViewableItemsChanged?: OnViewableItemsChanged<ItemT>;
 }

package/index.d.ts

@@ -5,6 +5,7 @@ import Animated$1 from 'react-native-reanimated';
 
 type ListenerType = "numContainers" | "numContainersPooled" | `containerItemKey${number}` | `containerItemData${number}` | `containerPosition${number}` | `containerColumn${number}` | `containerSticky${number}` | `containerStickyOffset${number}` | "containersDidLayout" | "extraData" | "numColumns" | "lastItemKeys" | "totalSize" | "alignItemsPaddingTop" | "stylePaddingTop" | "scrollAdjust" | "scrollAdjustUserOffset" | "headerSize" | "footerSize" | "maintainVisibleContentPosition" | "debugRawScroll" | "debugComputedScroll" | "otherAxisSize" | "snapToOffsets" | "scrollSize";
 interface StateContext {
+    internalState: InternalState | undefined;
     listeners: Map<ListenerType, Set<(value: any) => void>>;
     values: Map<ListenerType, any>;
     mapViewabilityCallbacks: Map<string, ViewabilityCallback>;
@@ -208,6 +209,13 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * @default 0.5
      */
     onStartReachedThreshold?: number | null | undefined;
+    /**
+     * Called when the sticky header changes.
+    */
+    onStickyHeaderChange?: (info: {
+        index: number;
+        item: any;
+    }) => void;
     /**
      * Called when the viewability of items changes.
      */
@@ -315,7 +323,7 @@ interface InternalState {
     timeoutSizeMessage: any;
     nativeMarginTop: number;
     indexByKey: Map<string, number>;
-    idCache: Map<number, string>;
+    idCache: string[];
     viewabilityConfigCallbackPairs: ViewabilityConfigCallbackPairs<any> | undefined;
     scrollHistory: Array<{
         scroll: number;
@@ -344,6 +352,7 @@ interface InternalState {
         viewOffset?: number;
         viewPosition?: number;
         animated?: boolean;
+        isInitialScroll?: boolean;
     } | undefined;
     needsOtherAxisSize?: boolean;
     averageSizes: Record<string, {
@@ -378,6 +387,7 @@ interface InternalState {
         onScroll: LegendListProps["onScroll"];
         onStartReached: LegendListProps["onStartReached"];
         onStartReachedThreshold: number | null | undefined;
+        onStickyHeaderChange: LegendListProps["onStickyHeaderChange"];
         recycleItems: boolean;
         suggestEstimatedItemSize: boolean;
         stylePaddingBottom: number | undefined;
@@ -540,7 +550,7 @@ interface ViewAmountToken<ItemT = any> extends ViewToken<ItemT> {
     percentOfScroller: number;
     scrollSize: number;
 }
-interface ViewabilityConfigCallbackPair<ItemT> {
+interface ViewabilityConfigCallbackPair<ItemT = any> {
     viewabilityConfig: ViewabilityConfig;
     onViewableItemsChanged?: OnViewableItemsChanged<ItemT>;
 }