@legendapp/list 3.0.6 → 3.1.0

package/reanimated.d.ts

@@ -9,8 +9,8 @@ interface MaintainVisibleContentPositionNormalized<ItemT = any> {
     shouldRestorePosition?: (item: ItemT, index: number, data: readonly ItemT[]) => boolean;
 }
 
-type ListenerType = "activeStickyIndex" | "alignItemsAtEndPadding" | "anchoredEndSpaceSize" | "debugComputedScroll" | "debugRawScroll" | "extraData" | "footerSize" | "headerSize" | "lastItemKeys" | "lastPositionUpdate" | "maintainVisibleContentPosition" | "numColumns" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "scrollAdjust" | "scrollAdjustPending" | "scrollAdjustUserOffset" | "scrollSize" | "snapToOffsets" | "stylePaddingTop" | "totalSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | `containerColumn${number}` | `containerSpan${number}` | `containerItemData${number}` | `containerItemKey${number}` | `containerPosition${number}` | `containerSticky${number}`;
-type LegendListListenerType = Extract<ListenerType, "activeStickyIndex" | "anchoredEndSpaceSize" | "footerSize" | "headerSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | "lastItemKeys" | "lastPositionUpdate" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "snapToOffsets" | "totalSize">;
+type ListenerType = "activeStickyIndex" | "alignItemsAtEndPadding" | "anchoredEndSpaceSize" | "debugComputedScroll" | "debugRawScroll" | "extraData" | "footerSize" | "headerSize" | "lastItemKeys" | "lastPositionUpdate" | "maintainVisibleContentPosition" | "numColumns" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "scrollAdjust" | "scrollAdjustPending" | "scrollAdjustUserOffset" | "scrollSize" | "snapToOffsets" | "stylePaddingTop" | "totalSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | "adaptiveRender" | `containerColumn${number}` | `containerSpan${number}` | `containerItemData${number}` | `containerItemKey${number}` | `containerPosition${number}` | `containerSticky${number}`;
+type LegendListListenerType = Extract<ListenerType, "activeStickyIndex" | "anchoredEndSpaceSize" | "footerSize" | "headerSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | "adaptiveRender" | "lastItemKeys" | "lastPositionUpdate" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "snapToOffsets" | "totalSize">;
 type ListenerTypeValueMap = {
     activeStickyIndex: number;
     alignItemsAtEndPadding: number;
@@ -44,6 +44,7 @@ type ListenerTypeValueMap = {
     snapToOffsets: number[];
     stylePaddingTop: number;
     totalSize: number;
+    adaptiveRender: "normal" | "light";
 } & {
     [K in ListenerType as K extends `containerItemKey${number}` ? K : never]: string;
 } & {
@@ -64,6 +65,12 @@ interface Insets {
     bottom: number;
     right: number;
 }
+interface LayoutRectangle {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
 interface NativeScrollEvent {
     contentOffset: {
         x: number;
@@ -85,6 +92,28 @@ interface NativeSyntheticEvent<T> {
 }
 type ViewStyle = Record<string, unknown>;
 type StyleProp<T> = T | T[] | null | undefined | false;
+type AdaptiveRender = "normal" | "light";
+interface AdaptiveRenderConfig {
+    /**
+     * Scroll velocity in pixels per millisecond above which items should switch to light mode.
+     * @default 4
+     */
+    enterVelocity?: number;
+    /**
+     * Scroll velocity in pixels per millisecond below which items can return to normal mode.
+     * @default 1
+     */
+    exitVelocity?: number;
+    /**
+     * Time to wait without velocity above exitVelocity before returning to normal mode.
+     * @default 1000
+     */
+    exitDelay?: number;
+    /**
+     * Called when the list-level adaptive render changes.
+     */
+    onChange?: (mode: AdaptiveRender) => void;
+}
 type BaseScrollViewProps<TScrollView> = Omit<TScrollView, "contentOffset" | "maintainVisibleContentPosition" | "stickyHeaderIndices" | "removeClippedSubviews" | "children" | "onScroll">;
 interface DataModeProps<ItemT, TItemType extends string | undefined> {
     /**
@@ -293,6 +322,10 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * Called when list layout metrics change.
      */
     onMetricsChange?: (metrics: LegendListMetrics) => void;
+    /**
+     * Configures the adaptive render signal. Items can use this to render a lighter version while scrolling quickly.
+     */
+    experimental_adaptiveRender?: AdaptiveRenderConfig;
     /**
      * Function to call when the user pulls to refresh.
      */
@@ -491,6 +524,14 @@ type LegendListState = {
     startBuffered: number;
 };
 type LegendListRef$1 = {
+    /**
+     * Clears internal virtualization caches.
+     * @param options - Cache clearing options.
+     * @param options.mode - `sizes` clears measurement caches. `full` also clears key/position caches.
+     */
+    clearCaches(options?: {
+        mode?: "sizes" | "full";
+    }): void;
     /**
      * Displays the scroll indicators momentarily.
      */
@@ -511,6 +552,11 @@ type LegendListRef$1 = {
      * Returns the internal state of the scroll virtualization.
      */
     getState(): LegendListState;
+    /**
+     * Reports an externally measured content inset. Pass null/undefined to clear.
+     * Values are merged on top of props/animated/native insets.
+     */
+    reportContentInset(inset?: Partial<Insets> | null): void;
     /**
      * Scrolls a specific index into view.
      * @param params - Parameters for scrolling.
@@ -577,29 +623,22 @@ type LegendListRef$1 = {
         animated?: boolean | undefined;
     }): Promise<void>;
     /**
-     * Sets or adds to the offset of the visible content anchor.
-     * @param value - The offset to set or add.
-     * @param animated - If true, uses Animated to animate the change.
+     * Sets a measured item size and recalculates list positions as needed.
+     * @param itemKey - The key of the item whose size changed.
+     * @param size - The measured item size.
      */
-    setVisibleContentAnchorOffset(value: number | ((val: number) => number)): void;
+    setItemSize(itemKey: string, size: Pick<LayoutRectangle, "height" | "width">): void;
     /**
      * Sets whether scroll processing is enabled.
      * @param enabled - If true, scroll processing is enabled.
      */
     setScrollProcessingEnabled(enabled: boolean): void;
     /**
-     * Clears internal virtualization caches.
-     * @param options - Cache clearing options.
-     * @param options.mode - `sizes` clears measurement caches. `full` also clears key/position caches.
-     */
-    clearCaches(options?: {
-        mode?: "sizes" | "full";
-    }): void;
-    /**
-     * Reports an externally measured content inset. Pass null/undefined to clear.
-     * Values are merged on top of props/animated/native insets.
+     * Sets or adds to the offset of the visible content anchor.
+     * @param value - The offset to set or add.
+     * @param animated - If true, uses Animated to animate the change.
      */
-    reportContentInset(inset?: Partial<Insets> | null): void;
+    setVisibleContentAnchorOffset(value: number | ((val: number) => number)): void;
 };
 interface ViewToken<ItemT = any> {
     containerId: number;

package/section-list.d.ts

@@ -65,8 +65,8 @@ interface MaintainVisibleContentPositionNormalized<ItemT = any> {
     shouldRestorePosition?: (item: ItemT, index: number, data: readonly ItemT[]) => boolean;
 }
 
-type ListenerType = "activeStickyIndex" | "alignItemsAtEndPadding" | "anchoredEndSpaceSize" | "debugComputedScroll" | "debugRawScroll" | "extraData" | "footerSize" | "headerSize" | "lastItemKeys" | "lastPositionUpdate" | "maintainVisibleContentPosition" | "numColumns" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "scrollAdjust" | "scrollAdjustPending" | "scrollAdjustUserOffset" | "scrollSize" | "snapToOffsets" | "stylePaddingTop" | "totalSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | `containerColumn${number}` | `containerSpan${number}` | `containerItemData${number}` | `containerItemKey${number}` | `containerPosition${number}` | `containerSticky${number}`;
-type LegendListListenerType = Extract<ListenerType, "activeStickyIndex" | "anchoredEndSpaceSize" | "footerSize" | "headerSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | "lastItemKeys" | "lastPositionUpdate" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "snapToOffsets" | "totalSize">;
+type ListenerType = "activeStickyIndex" | "alignItemsAtEndPadding" | "anchoredEndSpaceSize" | "debugComputedScroll" | "debugRawScroll" | "extraData" | "footerSize" | "headerSize" | "lastItemKeys" | "lastPositionUpdate" | "maintainVisibleContentPosition" | "numColumns" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "scrollAdjust" | "scrollAdjustPending" | "scrollAdjustUserOffset" | "scrollSize" | "snapToOffsets" | "stylePaddingTop" | "totalSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | "adaptiveRender" | `containerColumn${number}` | `containerSpan${number}` | `containerItemData${number}` | `containerItemKey${number}` | `containerPosition${number}` | `containerSticky${number}`;
+type LegendListListenerType = Extract<ListenerType, "activeStickyIndex" | "anchoredEndSpaceSize" | "footerSize" | "headerSize" | "isAtEnd" | "isAtStart" | "isNearEnd" | "isNearStart" | "isWithinMaintainScrollAtEndThreshold" | "adaptiveRender" | "lastItemKeys" | "lastPositionUpdate" | "numContainers" | "numContainersPooled" | "otherAxisSize" | "readyToRender" | "snapToOffsets" | "totalSize">;
 type ListenerTypeValueMap = {
     activeStickyIndex: number;
     alignItemsAtEndPadding: number;
@@ -100,6 +100,7 @@ type ListenerTypeValueMap = {
     snapToOffsets: number[];
     stylePaddingTop: number;
     totalSize: number;
+    adaptiveRender: "normal" | "light";
 } & {
     [K in ListenerType as K extends `containerItemKey${number}` ? K : never]: string;
 } & {
@@ -120,6 +121,12 @@ interface Insets {
     bottom: number;
     right: number;
 }
+interface LayoutRectangle {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
 interface NativeScrollEvent {
     contentOffset: {
         x: number;
@@ -141,6 +148,28 @@ interface NativeSyntheticEvent<T> {
 }
 type ViewStyle = Record<string, unknown>;
 type StyleProp<T> = T | T[] | null | undefined | false;
+type AdaptiveRender = "normal" | "light";
+interface AdaptiveRenderConfig {
+    /**
+     * Scroll velocity in pixels per millisecond above which items should switch to light mode.
+     * @default 4
+     */
+    enterVelocity?: number;
+    /**
+     * Scroll velocity in pixels per millisecond below which items can return to normal mode.
+     * @default 1
+     */
+    exitVelocity?: number;
+    /**
+     * Time to wait without velocity above exitVelocity before returning to normal mode.
+     * @default 1000
+     */
+    exitDelay?: number;
+    /**
+     * Called when the list-level adaptive render changes.
+     */
+    onChange?: (mode: AdaptiveRender) => void;
+}
 type BaseScrollViewProps<TScrollView> = Omit<TScrollView, "contentOffset" | "maintainVisibleContentPosition" | "stickyHeaderIndices" | "removeClippedSubviews" | "children" | "onScroll">;
 interface DataModeProps<ItemT, TItemType extends string | undefined> {
     /**
@@ -349,6 +378,10 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
      * Called when list layout metrics change.
      */
     onMetricsChange?: (metrics: LegendListMetrics) => void;
+    /**
+     * Configures the adaptive render signal. Items can use this to render a lighter version while scrolling quickly.
+     */
+    experimental_adaptiveRender?: AdaptiveRenderConfig;
     /**
      * Function to call when the user pulls to refresh.
      */
@@ -547,6 +580,14 @@ type LegendListState = {
     startBuffered: number;
 };
 type LegendListRef$1 = {
+    /**
+     * Clears internal virtualization caches.
+     * @param options - Cache clearing options.
+     * @param options.mode - `sizes` clears measurement caches. `full` also clears key/position caches.
+     */
+    clearCaches(options?: {
+        mode?: "sizes" | "full";
+    }): void;
     /**
      * Displays the scroll indicators momentarily.
      */
@@ -567,6 +608,11 @@ type LegendListRef$1 = {
      * Returns the internal state of the scroll virtualization.
      */
     getState(): LegendListState;
+    /**
+     * Reports an externally measured content inset. Pass null/undefined to clear.
+     * Values are merged on top of props/animated/native insets.
+     */
+    reportContentInset(inset?: Partial<Insets> | null): void;
     /**
      * Scrolls a specific index into view.
      * @param params - Parameters for scrolling.
@@ -633,29 +679,22 @@ type LegendListRef$1 = {
         animated?: boolean | undefined;
     }): Promise<void>;
     /**
-     * Sets or adds to the offset of the visible content anchor.
-     * @param value - The offset to set or add.
-     * @param animated - If true, uses Animated to animate the change.
+     * Sets a measured item size and recalculates list positions as needed.
+     * @param itemKey - The key of the item whose size changed.
+     * @param size - The measured item size.
      */
-    setVisibleContentAnchorOffset(value: number | ((val: number) => number)): void;
+    setItemSize(itemKey: string, size: Pick<LayoutRectangle, "height" | "width">): void;
     /**
      * Sets whether scroll processing is enabled.
      * @param enabled - If true, scroll processing is enabled.
      */
     setScrollProcessingEnabled(enabled: boolean): void;
     /**
-     * Clears internal virtualization caches.
-     * @param options - Cache clearing options.
-     * @param options.mode - `sizes` clears measurement caches. `full` also clears key/position caches.
-     */
-    clearCaches(options?: {
-        mode?: "sizes" | "full";
-    }): void;
-    /**
-     * Reports an externally measured content inset. Pass null/undefined to clear.
-     * Values are merged on top of props/animated/native insets.
+     * Sets or adds to the offset of the visible content anchor.
+     * @param value - The offset to set or add.
+     * @param animated - If true, uses Animated to animate the change.
      */
-    reportContentInset(inset?: Partial<Insets> | null): void;
+    setVisibleContentAnchorOffset(value: number | ((val: number) => number)): void;
 };
 interface ViewToken<ItemT = any> {
     containerId: number;