@legendapp/list 3.0.0-beta.52 → 3.0.0-beta.54

package/keyboard-chat.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { ScrollViewComponent, ScrollResponderMixin, Insets as Insets$1, ScrollViewProps } from 'react-native';
+import { ScrollViewComponent, ScrollResponderMixin, Insets as Insets$1, ScrollViewProps, View, LayoutChangeEvent } from 'react-native';
 import { KeyboardChatScrollViewProps } from 'react-native-keyboard-controller';
 import { SharedValue } from 'react-native-reanimated';
 import { AnimatedLegendListProps } from '@legendapp/list/reanimated';
@@ -71,6 +71,10 @@ interface AnchoredEndSpaceConfig$1 {
     includeInEndInset?: boolean;
     onSizeChanged?: (size: number) => void;
 }
+interface LegendListAverageItemSize {
+    average: number;
+    count: number;
+}
 type LegendListState = {
     activeStickyIndex: number;
     contentLength: number;
@@ -85,6 +89,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;
@@ -221,7 +226,7 @@ type LegendListRef = Omit<LegendListRef$1, "getNativeScrollRef" | "getScrollResp
     reportContentInset(inset?: Partial<Insets$1> | null): void;
 };
 
-type KeyboardChatScrollViewPropsUnique = Omit<KeyboardChatScrollViewProps, keyof ScrollViewProps | "inverted" | "ScrollViewComponent" | "blankSpace" | "onContentInsetChange">;
+type KeyboardChatScrollViewPropsUnique = Omit<KeyboardChatScrollViewProps, keyof ScrollViewProps | "inverted" | "ScrollViewComponent" | "blankSpace" | "extraContentPadding" | "onContentInsetChange">;
 type ScrollMessageToEndOptions = {
     animated: boolean;
     closeKeyboard: boolean;
@@ -237,12 +242,23 @@ type UseKeyboardScrollToEndOptions = {
     freeze?: SharedValue<boolean>;
     listRef: KeyboardScrollToEndListRef;
 };
+type KeyboardChatComposerInsetListRef = {
+    current: Pick<LegendListRef, "reportContentInset"> | null;
+};
+type KeyboardChatComposerRef = {
+    current: Pick<View, "measure"> | null;
+};
+declare function useKeyboardChatComposerInset(listRef: KeyboardChatComposerInsetListRef, composerRef: KeyboardChatComposerRef, initialHeight?: number): {
+    contentInsetEndAdjustment: SharedValue<number>;
+    onComposerLayout: (event: LayoutChangeEvent) => void;
+};
 declare function useKeyboardScrollToEnd({ freeze: freezeProp, listRef }: UseKeyboardScrollToEndOptions): {
     freeze: SharedValue<boolean>;
     scrollMessageToEnd: ({ animated, closeKeyboard }: ScrollMessageToEndOptions) => Promise<void>;
 };
-declare const KeyboardChatLegendList: <ItemT>(props: Omit<AnimatedLegendListProps<ItemT>, "anchoredEndSpace" | "renderScrollComponent"> & KeyboardChatScrollViewPropsUnique & {
+declare const KeyboardChatLegendList: <ItemT>(props: Omit<AnimatedLegendListProps<ItemT>, "anchoredEndSpace" | "contentInsetEndAdjustment" | "renderScrollComponent"> & KeyboardChatScrollViewPropsUnique & {
     anchoredEndSpace?: AnchoredEndSpaceConfig;
+    contentInsetEndAdjustment?: SharedValue<number>;
 } & React.RefAttributes<LegendListRef>) => React.ReactElement | null;
 
-export { KeyboardChatLegendList, useKeyboardScrollToEnd };
+export { KeyboardChatLegendList, useKeyboardChatComposerInset, useKeyboardScrollToEnd };

package/keyboard-chat.js

@@ -28,6 +28,34 @@ var React__namespace = /*#__PURE__*/_interopNamespace(React);
 
 // src/integrations/keyboard-chat.tsx
 var { typedForwardRef, useCombinedRef } = reactNative.internal;
+function useKeyboardChatComposerInset(listRef, composerRef, initialHeight = 0) {
+  const contentInsetEndAdjustment = reactNativeReanimated.useSharedValue(initialHeight);
+  const lastHeightRef = React.useRef(void 0);
+  const reportHeight = React.useCallback(
+    (height) => {
+      var _a;
+      if (Number.isFinite(height) && height !== lastHeightRef.current) {
+        lastHeightRef.current = height;
+        contentInsetEndAdjustment.value = height;
+        (_a = listRef.current) == null ? void 0 : _a.reportContentInset({ bottom: height });
+      }
+    },
+    [contentInsetEndAdjustment, listRef]
+  );
+  React.useLayoutEffect(() => {
+    var _a;
+    (_a = composerRef.current) == null ? void 0 : _a.measure((_x, _y, _width, height) => {
+      reportHeight(height);
+    });
+  }, [composerRef, reportHeight]);
+  const onComposerLayout = React.useCallback(
+    (event) => {
+      reportHeight(event.nativeEvent.layout.height);
+    },
+    [reportHeight]
+  );
+  return { contentInsetEndAdjustment, onComposerLayout };
+}
 function useKeyboardScrollToEnd({ freeze: freezeProp, listRef }) {
   const internalFreeze = reactNativeReanimated.useSharedValue(false);
   const freeze = freezeProp != null ? freezeProp : internalFreeze;
@@ -53,7 +81,7 @@ var KeyboardChatLegendList = typedForwardRef(function KeyboardChatLegendList2(pr
   const {
     anchoredEndSpace,
     applyWorkaroundForContentInsetHitTestBug,
-    extraContentPadding,
+    contentInsetEndAdjustment,
     freeze,
     keyboardLiftBehavior,
     offset,
@@ -93,7 +121,7 @@ var KeyboardChatLegendList = typedForwardRef(function KeyboardChatLegendList2(pr
           ...scrollProps,
           applyWorkaroundForContentInsetHitTestBug,
           blankSpace,
-          extraContentPadding,
+          extraContentPadding: contentInsetEndAdjustment,
           keyboardLiftBehavior,
           offset,
           onContentInsetChange
@@ -103,7 +131,7 @@ var KeyboardChatLegendList = typedForwardRef(function KeyboardChatLegendList2(pr
     [
       applyWorkaroundForContentInsetHitTestBug,
       blankSpace,
-      extraContentPadding,
+      contentInsetEndAdjustment,
       freeze,
       keyboardLiftBehavior,
       onContentInsetChange,
@@ -123,4 +151,5 @@ var KeyboardChatLegendList = typedForwardRef(function KeyboardChatLegendList2(pr
 });
 
 exports.KeyboardChatLegendList = KeyboardChatLegendList;
+exports.useKeyboardChatComposerInset = useKeyboardChatComposerInset;
 exports.useKeyboardScrollToEnd = useKeyboardScrollToEnd;

package/keyboard-chat.mjs

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { useRef, useEffect, useMemo, useCallback } from 'react';
+import { useRef, useEffect, useMemo, useCallback, useLayoutEffect } from 'react';
 import { KeyboardChatScrollView, KeyboardController } from 'react-native-keyboard-controller';
 import { useSharedValue } from 'react-native-reanimated';
 import { internal } from '@legendapp/list/react-native';
@@ -7,6 +7,34 @@ import { AnimatedLegendList } from '@legendapp/list/reanimated';
 
 // src/integrations/keyboard-chat.tsx
 var { typedForwardRef, useCombinedRef } = internal;
+function useKeyboardChatComposerInset(listRef, composerRef, initialHeight = 0) {
+  const contentInsetEndAdjustment = useSharedValue(initialHeight);
+  const lastHeightRef = useRef(void 0);
+  const reportHeight = useCallback(
+    (height) => {
+      var _a;
+      if (Number.isFinite(height) && height !== lastHeightRef.current) {
+        lastHeightRef.current = height;
+        contentInsetEndAdjustment.value = height;
+        (_a = listRef.current) == null ? void 0 : _a.reportContentInset({ bottom: height });
+      }
+    },
+    [contentInsetEndAdjustment, listRef]
+  );
+  useLayoutEffect(() => {
+    var _a;
+    (_a = composerRef.current) == null ? void 0 : _a.measure((_x, _y, _width, height) => {
+      reportHeight(height);
+    });
+  }, [composerRef, reportHeight]);
+  const onComposerLayout = useCallback(
+    (event) => {
+      reportHeight(event.nativeEvent.layout.height);
+    },
+    [reportHeight]
+  );
+  return { contentInsetEndAdjustment, onComposerLayout };
+}
 function useKeyboardScrollToEnd({ freeze: freezeProp, listRef }) {
   const internalFreeze = useSharedValue(false);
   const freeze = freezeProp != null ? freezeProp : internalFreeze;
@@ -32,7 +60,7 @@ var KeyboardChatLegendList = typedForwardRef(function KeyboardChatLegendList2(pr
   const {
     anchoredEndSpace,
     applyWorkaroundForContentInsetHitTestBug,
-    extraContentPadding,
+    contentInsetEndAdjustment,
     freeze,
     keyboardLiftBehavior,
     offset,
@@ -72,7 +100,7 @@ var KeyboardChatLegendList = typedForwardRef(function KeyboardChatLegendList2(pr
           ...scrollProps,
           applyWorkaroundForContentInsetHitTestBug,
           blankSpace,
-          extraContentPadding,
+          extraContentPadding: contentInsetEndAdjustment,
           keyboardLiftBehavior,
           offset,
           onContentInsetChange
@@ -82,7 +110,7 @@ var KeyboardChatLegendList = typedForwardRef(function KeyboardChatLegendList2(pr
     [
       applyWorkaroundForContentInsetHitTestBug,
       blankSpace,
-      extraContentPadding,
+      contentInsetEndAdjustment,
       freeze,
       keyboardLiftBehavior,
       onContentInsetChange,
@@ -101,4 +129,4 @@ var KeyboardChatLegendList = typedForwardRef(function KeyboardChatLegendList2(pr
   );
 });
 
-export { KeyboardChatLegendList, useKeyboardScrollToEnd };
+export { KeyboardChatLegendList, useKeyboardChatComposerInset, useKeyboardScrollToEnd };

package/keyboard-test.d.ts

@@ -1,6 +1,7 @@
 import * as React from 'react';
 import { ScrollViewComponent, ScrollResponderMixin, Insets as Insets$1, ScrollViewProps } from 'react-native';
 import { KeyboardChatScrollViewProps } from 'react-native-keyboard-controller';
+import { SharedValue } from 'react-native-reanimated';
 export { useKeyboardScrollToEnd } from '@legendapp/list/keyboard-chat';
 import { AnimatedLegendListProps } from '@legendapp/list/reanimated';
 
@@ -64,6 +65,10 @@ interface Insets {
     bottom: number;
     right: number;
 }
+interface LegendListAverageItemSize {
+    average: number;
+    count: number;
+}
 type LegendListState = {
     activeStickyIndex: number;
     contentLength: number;
@@ -78,6 +83,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;
@@ -211,7 +217,9 @@ type LegendListRef = Omit<LegendListRef$1, "getNativeScrollRef" | "getScrollResp
     reportContentInset(inset?: Partial<Insets$1> | null): void;
 };
 
-type KeyboardChatScrollViewPropsUnique = Omit<KeyboardChatScrollViewProps, keyof ScrollViewProps | "inverted" | "ScrollViewComponent" | "onContentInsetChange">;
-declare const KeyboardAvoidingLegendList: <ItemT>(props: Omit<AnimatedLegendListProps<ItemT>, "renderScrollComponent"> & KeyboardChatScrollViewPropsUnique & React.RefAttributes<LegendListRef>) => React.ReactElement | null;
+type KeyboardChatScrollViewPropsUnique = Omit<KeyboardChatScrollViewProps, keyof ScrollViewProps | "inverted" | "ScrollViewComponent" | "extraContentPadding" | "onContentInsetChange">;
+declare const KeyboardAvoidingLegendList: <ItemT>(props: Omit<AnimatedLegendListProps<ItemT>, "contentInsetEndAdjustment" | "renderScrollComponent"> & KeyboardChatScrollViewPropsUnique & {
+    contentInsetEndAdjustment?: SharedValue<number>;
+} & React.RefAttributes<LegendListRef>) => React.ReactElement | null;
 
 export { KeyboardAvoidingLegendList };

package/keyboard-test.js

@@ -29,7 +29,7 @@ var React__namespace = /*#__PURE__*/_interopNamespace(React);
 // src/integrations/keyboard-test.tsx
 var { typedForwardRef, useCombinedRef } = reactNative.internal;
 var KeyboardAvoidingLegendList = typedForwardRef(function KeyboardAvoidingLegendList2(props, forwardedRef) {
-  const { extraContentPadding, ...rest } = props;
+  const { contentInsetEndAdjustment, ...rest } = props;
   const refLegendList = React.useRef(null);
   const combinedRef = useCombinedRef(forwardedRef, refLegendList);
   const onContentInsetChange = React.useCallback((insets) => {
@@ -41,11 +41,11 @@ var KeyboardAvoidingLegendList = typedForwardRef(function KeyboardAvoidingLegend
       reactNativeKeyboardController.KeyboardChatScrollView,
       {
         ...listProps,
-        extraContentPadding,
+        extraContentPadding: contentInsetEndAdjustment,
         onContentInsetChange
       }
     ),
-    [extraContentPadding, onContentInsetChange]
+    [contentInsetEndAdjustment, onContentInsetChange]
   );
   return /* @__PURE__ */ React__namespace.createElement(reanimated.AnimatedLegendList, { ref: combinedRef, renderScrollComponent: memoList, ...rest });
 });

package/keyboard-test.mjs

@@ -8,7 +8,7 @@ import { AnimatedLegendList } from '@legendapp/list/reanimated';
 // src/integrations/keyboard-test.tsx
 var { typedForwardRef, useCombinedRef } = internal;
 var KeyboardAvoidingLegendList = typedForwardRef(function KeyboardAvoidingLegendList2(props, forwardedRef) {
-  const { extraContentPadding, ...rest } = props;
+  const { contentInsetEndAdjustment, ...rest } = props;
   const refLegendList = useRef(null);
   const combinedRef = useCombinedRef(forwardedRef, refLegendList);
   const onContentInsetChange = useCallback((insets) => {
@@ -20,11 +20,11 @@ var KeyboardAvoidingLegendList = typedForwardRef(function KeyboardAvoidingLegend
       KeyboardChatScrollView,
       {
         ...listProps,
-        extraContentPadding,
+        extraContentPadding: contentInsetEndAdjustment,
         onContentInsetChange
       }
     ),
-    [extraContentPadding, onContentInsetChange]
+    [contentInsetEndAdjustment, onContentInsetChange]
   );
   return /* @__PURE__ */ React.createElement(AnimatedLegendList, { ref: combinedRef, renderScrollComponent: memoList, ...rest });
 });

package/keyboard.d.ts

@@ -63,6 +63,10 @@ interface Insets {
     bottom: number;
     right: number;
 }
+interface LegendListAverageItemSize {
+    average: number;
+    count: number;
+}
 type LegendListState = {
     activeStickyIndex: number;
     contentLength: number;
@@ -77,6 +81,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@legendapp/list",
-  "version": "3.0.0-beta.52",
+  "version": "3.0.0-beta.54",
   "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

@@ -160,7 +160,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;
     /**
@@ -178,8 +181,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;
     /**
@@ -254,6 +258,11 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * Keeps an item visually anchored to the start by adding trailing space when the content below it underflows.
      */
     anchoredEndSpace?: AnchoredEndSpaceConfig;
+    /**
+     * Adjusts the effective end content inset for web lists without replacing the base contentInset.
+     * The adjustment is also rendered as real content padding so the browser scroll range includes it.
+     */
+    contentInsetEndAdjustment?: number;
     /**
      * Number of columns to render items in.
      * @default 1
@@ -355,12 +364,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.
      */
@@ -449,6 +452,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;
@@ -470,6 +477,7 @@ type LegendListState$1 = {
     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;
@@ -679,7 +687,7 @@ interface InitialScrollAnchor extends ScrollIndexWithOffsetPosition {
     settledTicks?: number;
 }
 
-type LegendListPropsOverrides<ItemT, TItemType extends string | undefined> = Omit<LegendListPropsBase<ItemT, ScrollViewProps, TItemType>, "anchoredEndSpace" | "onScroll" | "refScrollView" | "renderScrollComponent" | "ListHeaderComponentStyle" | "ListFooterComponentStyle"> & {
+type LegendListPropsOverrides<ItemT, TItemType extends string | undefined> = Omit<LegendListPropsBase<ItemT, ScrollViewProps, TItemType>, "anchoredEndSpace" | "contentInsetEndAdjustment" | "onScroll" | "refScrollView" | "renderScrollComponent" | "ListHeaderComponentStyle" | "ListFooterComponentStyle"> & {
     onScroll?: (event: NativeSyntheticEvent$1<NativeScrollEvent$1>) => void;
     refScrollView?: React.Ref<ScrollView>;
     renderScrollComponent?: (props: ScrollViewProps) => React.ReactElement<ScrollViewProps>;
@@ -710,4 +718,4 @@ declare function useSyncLayout(): () => void;
 
 declare const LegendList: LegendListComponent;
 
-export { type AlwaysRenderConfig, type ColumnWrapperStyle, type InitialScrollAnchor, type Insets, type LayoutRectangle, LegendList, 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, useIsLastItem, useListScrollSize, useRecyclingEffect, useRecyclingState, useSyncLayout, useViewability, useViewabilityAmount };
+export { type AlwaysRenderConfig, type ColumnWrapperStyle, type InitialScrollAnchor, 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, useIsLastItem, useListScrollSize, useRecyclingEffect, useRecyclingState, useSyncLayout, useViewability, useViewabilityAmount };