@legendapp/list 1.0.14 → 1.0.16

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 1.0.16
+- Fix: isAtEnd was going to false when overscrolling
+- Fix: refreshControl not being top padded correctly
+- Fix: type of useLastItem hook
+- Fix: header component was not displaying if a list had no data
+- Fix: scrollToIndex logic that fixes scroll after items layout was not using viewPosition/viewOffset
+- Fix: Improve scrollToIndex accuracy
+- Fix: Improve scrollToEnd accuracy
+
+## 1.0.15
+- Feat: Add a useIsLastItem hook
+- Feat: Support horizontal lists without an intrinsic height, it takes the maximum height of list items
+- Feat: Add onLoad prop
+- Fix: maintainVisibleContentPosition not working on horizontal lists
+- Perf: scrollForNextCalculateItemsInView was not taking drawDistance into account correctly
+- Perf: Improved the algorithm for allocating containers to items
+- Perf: Use useLayoutEffect in LegendList if available to get the outer ScrollView layout as soon as possible
+
+## 1.0.14
+- Fix: A container changing size while inactive but not yet recycled could potentially overlap with elements onscreen if large enough
+
 ## 1.0.13
 - Fix: Missing React import in ListHeaderComponentContainer crashing some environments
 - Fix: `initialScrollIndex` was off by padding if using "padding" or "paddingVertical" props

package/animated.d.mts

@@ -48,12 +48,15 @@ declare const AnimatedLegendList: Animated.AnimatedComponent<(<T>(props: Omit<Om
     recycleItems?: boolean;
     refScrollView?: React.Ref<react_native.ScrollView>;
     refreshing?: boolean;
-    renderItem?: ((props: _legendapp_list.LegendListRenderItemProps<T>) => React$1.ReactNode) | undefined;
+    renderItem?: React$1.ComponentType<_legendapp_list.LegendListRenderItemProps<T>> | ((props: _legendapp_list.LegendListRenderItemProps<T>) => React$1.ReactNode) | undefined;
     renderScrollComponent?: (props: react_native.ScrollViewProps) => React.ReactElement<react_native.ScrollViewProps>;
     suggestEstimatedItemSize?: boolean;
     viewabilityConfig?: _legendapp_list.ViewabilityConfig;
     viewabilityConfigCallbackPairs?: _legendapp_list.ViewabilityConfigCallbackPairs | undefined;
     waitForInitialLayout?: boolean;
+    onLoad?: (info: {
+        elapsedTimeInMs: number;
+    }) => void;
 } & React$1.RefAttributes<_legendapp_list.LegendListRef>) => React.ReactNode)>;
 
 export { AnimatedLegendList };

package/animated.d.ts

@@ -48,12 +48,15 @@ declare const AnimatedLegendList: Animated.AnimatedComponent<(<T>(props: Omit<Om
     recycleItems?: boolean;
     refScrollView?: React.Ref<react_native.ScrollView>;
     refreshing?: boolean;
-    renderItem?: ((props: _legendapp_list.LegendListRenderItemProps<T>) => React$1.ReactNode) | undefined;
+    renderItem?: React$1.ComponentType<_legendapp_list.LegendListRenderItemProps<T>> | ((props: _legendapp_list.LegendListRenderItemProps<T>) => React$1.ReactNode) | undefined;
     renderScrollComponent?: (props: react_native.ScrollViewProps) => React.ReactElement<react_native.ScrollViewProps>;
     suggestEstimatedItemSize?: boolean;
     viewabilityConfig?: _legendapp_list.ViewabilityConfig;
     viewabilityConfigCallbackPairs?: _legendapp_list.ViewabilityConfigCallbackPairs | undefined;
     waitForInitialLayout?: boolean;
+    onLoad?: (info: {
+        elapsedTimeInMs: number;
+    }) => void;
 } & React$1.RefAttributes<_legendapp_list.LegendListRef>) => React.ReactNode)>;
 
 export { AnimatedLegendList };

package/index.d.mts

@@ -180,10 +180,13 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
      */
     refreshing?: boolean;
     /**
-     * Function to render each item in the list.
+     * Function or React component to render each item in the list.
+     * Can be either:
+     * - A function: (props: LegendListRenderItemProps<ItemT>) => ReactNode
+     * - A React component: React.ComponentType<LegendListRenderItemProps<ItemT>>
      * @required
      */
-    renderItem?: (props: LegendListRenderItemProps<ItemT>) => ReactNode;
+    renderItem?: ((props: LegendListRenderItemProps<ItemT>) => ReactNode) | React.ComponentType<LegendListRenderItemProps<ItemT>>;
     /**
      * Render custom ScrollView component.
      * @default (props) => <ScrollView {...props} />
@@ -208,6 +211,9 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
      * @default false
      */
     waitForInitialLayout?: boolean;
+    onLoad?: (info: {
+        elapsedTimeInMs: number;
+    }) => void;
 };
 interface ColumnWrapperStyle {
     rowGap?: number;
@@ -234,8 +240,8 @@ interface InternalState {
     pendingAdjust: number;
     isStartReached: boolean;
     isEndReached: boolean;
-    isAtBottom: boolean;
-    isAtTop: boolean;
+    isAtEnd: boolean;
+    isAtStart: boolean;
     data: readonly any[];
     hasScrolled?: boolean;
     scrollLength: number;
@@ -259,7 +265,7 @@ interface InternalState {
     nativeMarginTop: number;
     indexByKey: Map<string, number>;
     viewabilityConfigCallbackPairs: ViewabilityConfigCallbackPairs | undefined;
-    renderItem: (props: LegendListRenderItemProps<any>) => ReactNode;
+    renderItem: ((props: LegendListRenderItemProps<any>) => ReactNode) | React.ComponentType<LegendListRenderItemProps<any>>;
     scrollHistory: Array<{
         scroll: number;
         time: number;
@@ -278,8 +284,15 @@ interface InternalState {
     lastBatchingAction: number;
     ignoreScrollFromCalcTotal?: boolean;
     disableScrollJumpsFrom?: number;
-    scrollingToOffset?: number | undefined;
+    scrollingTo?: {
+        offset: number;
+        index?: number;
+        viewOffset?: number;
+        viewPosition?: number;
+        animated?: boolean;
+    } | undefined;
     previousTotalSize?: number;
+    needsOtherAxisSize?: boolean;
     averageSizes: Record<string, {
         num: number;
         avg: number;
@@ -509,17 +522,21 @@ declare const LegendList: <T>(props: Omit<Omit<react_native.ScrollViewProps, "sc
     recycleItems?: boolean;
     refScrollView?: React$1.Ref<ScrollView>;
     refreshing?: boolean;
-    renderItem?: ((props: LegendListRenderItemProps<T>) => React$1.ReactNode) | undefined;
+    renderItem?: React$1.ComponentType<LegendListRenderItemProps<T>> | ((props: LegendListRenderItemProps<T>) => React$1.ReactNode) | undefined;
     renderScrollComponent?: (props: react_native.ScrollViewProps) => React$1.ReactElement<react_native.ScrollViewProps>;
     suggestEstimatedItemSize?: boolean;
     viewabilityConfig?: ViewabilityConfig;
     viewabilityConfigCallbackPairs?: ViewabilityConfigCallbackPairs | undefined;
     waitForInitialLayout?: boolean;
+    onLoad?: (info: {
+        elapsedTimeInMs: number;
+    }) => void;
 } & React$1.RefAttributes<LegendListRef>) => React$1.ReactNode;
 
 declare function useViewability(callback: ViewabilityCallback, configId?: string): void;
 declare function useViewabilityAmount(callback: ViewabilityAmountCallback): void;
 declare function useRecyclingEffect(effect: (info: LegendListRecyclingState<unknown>) => void | (() => void)): void;
 declare function useRecyclingState<ItemT>(valueOrFun: ((info: LegendListRecyclingState<ItemT>) => ItemT) | ItemT): readonly [ItemT | null, Dispatch<SetStateAction<ItemT>>];
+declare function useIsLastItem(): boolean;
 
-export { type AnchoredPosition, type ColumnWrapperStyle, type InternalState, LegendList, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type OnViewableItemsChanged, type ScrollState, type TypedForwardRef, type TypedMemo, type ViewAmountToken, type ViewToken, type ViewabilityAmountCallback, type ViewabilityCallback, type ViewabilityConfig, type ViewabilityConfigCallbackPair, type ViewabilityConfigCallbackPairs, type ViewableRange, typedForwardRef, typedMemo, useRecyclingEffect, useRecyclingState, useViewability, useViewabilityAmount };
+export { type AnchoredPosition, type ColumnWrapperStyle, type InternalState, LegendList, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type OnViewableItemsChanged, type ScrollState, type TypedForwardRef, type TypedMemo, type ViewAmountToken, type ViewToken, type ViewabilityAmountCallback, type ViewabilityCallback, type ViewabilityConfig, type ViewabilityConfigCallbackPair, type ViewabilityConfigCallbackPairs, type ViewableRange, typedForwardRef, typedMemo, useIsLastItem, useRecyclingEffect, useRecyclingState, useViewability, useViewabilityAmount };

package/index.d.ts

@@ -180,10 +180,13 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
      */
     refreshing?: boolean;
     /**
-     * Function to render each item in the list.
+     * Function or React component to render each item in the list.
+     * Can be either:
+     * - A function: (props: LegendListRenderItemProps<ItemT>) => ReactNode
+     * - A React component: React.ComponentType<LegendListRenderItemProps<ItemT>>
      * @required
      */
-    renderItem?: (props: LegendListRenderItemProps<ItemT>) => ReactNode;
+    renderItem?: ((props: LegendListRenderItemProps<ItemT>) => ReactNode) | React.ComponentType<LegendListRenderItemProps<ItemT>>;
     /**
      * Render custom ScrollView component.
      * @default (props) => <ScrollView {...props} />
@@ -208,6 +211,9 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
      * @default false
      */
     waitForInitialLayout?: boolean;
+    onLoad?: (info: {
+        elapsedTimeInMs: number;
+    }) => void;
 };
 interface ColumnWrapperStyle {
     rowGap?: number;
@@ -234,8 +240,8 @@ interface InternalState {
     pendingAdjust: number;
     isStartReached: boolean;
     isEndReached: boolean;
-    isAtBottom: boolean;
-    isAtTop: boolean;
+    isAtEnd: boolean;
+    isAtStart: boolean;
     data: readonly any[];
     hasScrolled?: boolean;
     scrollLength: number;
@@ -259,7 +265,7 @@ interface InternalState {
     nativeMarginTop: number;
     indexByKey: Map<string, number>;
     viewabilityConfigCallbackPairs: ViewabilityConfigCallbackPairs | undefined;
-    renderItem: (props: LegendListRenderItemProps<any>) => ReactNode;
+    renderItem: ((props: LegendListRenderItemProps<any>) => ReactNode) | React.ComponentType<LegendListRenderItemProps<any>>;
     scrollHistory: Array<{
         scroll: number;
         time: number;
@@ -278,8 +284,15 @@ interface InternalState {
     lastBatchingAction: number;
     ignoreScrollFromCalcTotal?: boolean;
     disableScrollJumpsFrom?: number;
-    scrollingToOffset?: number | undefined;
+    scrollingTo?: {
+        offset: number;
+        index?: number;
+        viewOffset?: number;
+        viewPosition?: number;
+        animated?: boolean;
+    } | undefined;
     previousTotalSize?: number;
+    needsOtherAxisSize?: boolean;
     averageSizes: Record<string, {
         num: number;
         avg: number;
@@ -509,17 +522,21 @@ declare const LegendList: <T>(props: Omit<Omit<react_native.ScrollViewProps, "sc
     recycleItems?: boolean;
     refScrollView?: React$1.Ref<ScrollView>;
     refreshing?: boolean;
-    renderItem?: ((props: LegendListRenderItemProps<T>) => React$1.ReactNode) | undefined;
+    renderItem?: React$1.ComponentType<LegendListRenderItemProps<T>> | ((props: LegendListRenderItemProps<T>) => React$1.ReactNode) | undefined;
     renderScrollComponent?: (props: react_native.ScrollViewProps) => React$1.ReactElement<react_native.ScrollViewProps>;
     suggestEstimatedItemSize?: boolean;
     viewabilityConfig?: ViewabilityConfig;
     viewabilityConfigCallbackPairs?: ViewabilityConfigCallbackPairs | undefined;
     waitForInitialLayout?: boolean;
+    onLoad?: (info: {
+        elapsedTimeInMs: number;
+    }) => void;
 } & React$1.RefAttributes<LegendListRef>) => React$1.ReactNode;
 
 declare function useViewability(callback: ViewabilityCallback, configId?: string): void;
 declare function useViewabilityAmount(callback: ViewabilityAmountCallback): void;
 declare function useRecyclingEffect(effect: (info: LegendListRecyclingState<unknown>) => void | (() => void)): void;
 declare function useRecyclingState<ItemT>(valueOrFun: ((info: LegendListRecyclingState<ItemT>) => ItemT) | ItemT): readonly [ItemT | null, Dispatch<SetStateAction<ItemT>>];
+declare function useIsLastItem(): boolean;
 
-export { type AnchoredPosition, type ColumnWrapperStyle, type InternalState, LegendList, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type OnViewableItemsChanged, type ScrollState, type TypedForwardRef, type TypedMemo, type ViewAmountToken, type ViewToken, type ViewabilityAmountCallback, type ViewabilityCallback, type ViewabilityConfig, type ViewabilityConfigCallbackPair, type ViewabilityConfigCallbackPairs, type ViewableRange, typedForwardRef, typedMemo, useRecyclingEffect, useRecyclingState, useViewability, useViewabilityAmount };
+export { type AnchoredPosition, type ColumnWrapperStyle, type InternalState, LegendList, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type OnViewableItemsChanged, type ScrollState, type TypedForwardRef, type TypedMemo, type ViewAmountToken, type ViewToken, type ViewabilityAmountCallback, type ViewabilityCallback, type ViewabilityConfig, type ViewabilityConfigCallbackPair, type ViewabilityConfigCallbackPairs, type ViewableRange, typedForwardRef, typedMemo, useIsLastItem, useRecyclingEffect, useRecyclingState, useViewability, useViewabilityAmount };