@legendapp/list 3.3.11 → 3.5.0

package/react.d.ts

@@ -6,11 +6,14 @@ type ScrollEventTarget = Window | HTMLElement;
 interface ScrollViewMethods {
     getBoundingClientRect(): DOMRect | null | undefined;
     getCurrentScrollOffset(): number;
+    getRawScrollOffset(): number;
     getMaxScrollOffset(): number;
-    getScrollableNode(): HTMLElement;
+    getScrollableNode(): HTMLElement | null;
     getScrollEventTarget(): ScrollEventTarget | null;
     getScrollResponder(): HTMLElement | null;
     isWindowScroll?(): boolean;
+    getContentNode?(): HTMLElement | null;
+    isScrollInRange?(): boolean;
     scrollBy(x: number, y: number): void;
     scrollTo(options: {
         x?: number;
@@ -357,6 +360,12 @@ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
     onLoad?: (info: {
         elapsedTimeInMs: number;
     }) => void;
+    /**
+     * Called after layout and initial scrolling complete, including after a
+     * dataKey reset. Unlike onLoad, this runs for each initial placement cycle.
+     * Ordinary data updates do not trigger it unless they restart initial placement.
+     */
+    onReady?: () => void;
     /**
      * Called when list layout metrics change.
      */
@@ -812,6 +821,7 @@ interface LooseScrollViewProps {
     onMomentumScrollEnd?: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
     onScroll?: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
     onScrollBeginDrag?: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    onScrollEndDrag?: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
     refreshControl?: ReactElement | null;
     removeClippedSubviews?: boolean;
     scrollEventThrottle?: number;
@@ -829,6 +839,13 @@ type ScrollViewPropsWeb = Omit<LooseScrollViewProps, "style" | "contentContainer
     onLayout?: (event: LooseLayoutChangeEvent) => void;
 };
 type LegendListPropsOverrides<ItemT, TItemType extends string | undefined> = Omit<LegendListPropsBase<ItemT, ScrollViewPropsWeb, TItemType>, "anchoredEndSpace" | "refScrollView" | "renderScrollComponent" | "ListHeaderComponentStyle" | "ListFooterComponentStyle" | "onRefresh" | "progressViewOffset" | "refreshing"> & {
+    /**
+     * Web only: use an ancestor element's scrollbar instead of creating a scrollable list.
+     * Pass a state-backed callback ref value so changes to the element are observed.
+     * null waits for the element to mount; undefined uses the list's own scrollbar.
+     * Takes precedence over useWindowScroll. Not supported with renderScrollComponent.
+     */
+    scrollElement?: HTMLElement | null;
     anchoredEndSpace?: AnchoredEndSpaceConfig;
     refScrollView?: Ref<HTMLElement | ScrollViewMethods>;
     ListHeaderComponentStyle?: CSSProperties | undefined;
@@ -838,7 +855,7 @@ type LegendListProps<ItemT = any, TItemType extends string | undefined = string
 type LegendListRef = Omit<LegendListRef$1, "getAnimatableRef" | "getNativeScrollRef" | "getScrollableNode" | "getScrollResponder"> & {
     getAnimatableRef(): HTMLElement | ScrollViewMethods;
     getNativeScrollRef(): HTMLElement | ScrollViewMethods;
-    getScrollableNode(): HTMLElement;
+    getScrollableNode(): HTMLElement | null;
     getScrollResponder(): HTMLElement | null;
 };
 type LegendListState = Omit<LegendListState$1, "elementAtIndex"> & {