@legendapp/list 2.0.0-next.9 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.mts CHANGED
@@ -1,11 +1,9 @@
1
- import * as _legendapp_list_reanimated from '@legendapp/list/reanimated';
2
1
  import * as React$1 from 'react';
3
2
  import { ComponentProps, ReactNode, Dispatch, SetStateAction } from 'react';
4
- import * as react_native from 'react-native';
5
- import { View, ScrollView, Animated, StyleProp, ViewStyle, ScrollViewProps, LayoutRectangle, NativeSyntheticEvent, NativeScrollEvent, ScrollViewComponent, ScrollResponderMixin } from 'react-native';
3
+ import { View, Animated, ScrollView, LayoutRectangle, ScrollViewComponent, ScrollResponderMixin, StyleProp, ViewStyle, NativeSyntheticEvent, NativeScrollEvent, ScrollViewProps } from 'react-native';
6
4
  import Animated$1 from 'react-native-reanimated';
7
5
 
8
- type ListenerType = "numContainers" | "numContainersPooled" | `containerItemKey${number}` | `containerItemData${number}` | `containerPosition${number}` | `containerColumn${number}` | "containersDidLayout" | "extraData" | "numColumns" | "lastItemKeys" | "totalSize" | "alignItemsPaddingTop" | "stylePaddingTop" | "scrollAdjust" | "scrollAdjustUserOffset" | "headerSize" | "footerSize" | "maintainVisibleContentPosition" | "debugRawScroll" | "debugComputedScroll" | "otherAxisSize" | "snapToOffsets" | "scrollSize";
6
+ 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";
9
7
  interface StateContext {
10
8
  listeners: Map<ListenerType, Set<(value: any) => void>>;
11
9
  values: Map<ListenerType, any>;
@@ -13,8 +11,16 @@ interface StateContext {
13
11
  mapViewabilityValues: Map<string, ViewToken>;
14
12
  mapViewabilityAmountCallbacks: Map<number, ViewabilityAmountCallback>;
15
13
  mapViewabilityAmountValues: Map<number, ViewAmountToken>;
14
+ mapViewabilityConfigStates: Map<string, {
15
+ viewableItems: ViewToken[];
16
+ start: number;
17
+ end: number;
18
+ previousStart: number;
19
+ previousEnd: number;
20
+ }>;
16
21
  columnWrapperStyle: ColumnWrapperStyle | undefined;
17
22
  viewRefs: Map<number, React$1.RefObject<View>>;
23
+ animatedScrollY: Animated.Value;
18
24
  }
19
25
 
20
26
  declare class ScrollAdjustHandler {
@@ -24,23 +30,51 @@ declare class ScrollAdjustHandler {
24
30
  constructor(ctx: StateContext);
25
31
  requestAdjust(add: number): void;
26
32
  setMounted(): void;
33
+ getAdjust(): number;
27
34
  }
28
35
 
29
- type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof ScrollView> | ComponentProps<typeof Animated.ScrollView> | ComponentProps<typeof Animated$1.ScrollView>> = Omit<TScrollView, "contentOffset" | "contentInset" | "maintainVisibleContentPosition" | "stickyHeaderIndices" | "removeClippedSubviews" | "children"> & {
36
+ type BaseScrollViewProps<TScrollView> = Omit<TScrollView, "contentOffset" | "contentInset" | "maintainVisibleContentPosition" | "stickyHeaderIndices" | "removeClippedSubviews" | "children" | "onScroll">;
37
+ interface DataModeProps<ItemT, TItemType extends string | undefined> {
38
+ /**
39
+ * Array of items to render in the list.
40
+ * @required when using data mode
41
+ */
42
+ data: ReadonlyArray<ItemT>;
43
+ /**
44
+ * Function or React component to render each item in the list.
45
+ * Can be either:
46
+ * - A function: (props: LegendListRenderItemProps<ItemT>) => ReactNode
47
+ * - A React component: React.ComponentType<LegendListRenderItemProps<ItemT>>
48
+ * @required when using data mode
49
+ */
50
+ renderItem: ((props: LegendListRenderItemProps<ItemT, TItemType>) => ReactNode) | React.ComponentType<LegendListRenderItemProps<ItemT, TItemType>>;
51
+ children?: never;
52
+ }
53
+ interface ChildrenModeProps {
54
+ /**
55
+ * React children elements to render as list items.
56
+ * Each child will be treated as an individual list item.
57
+ * @required when using children mode
58
+ */
59
+ children: ReactNode;
60
+ data?: never;
61
+ renderItem?: never;
62
+ }
63
+ interface LegendListSpecificProps<ItemT, TItemType extends string | undefined> {
30
64
  /**
31
65
  * If true, aligns items at the end of the list.
32
66
  * @default false
33
67
  */
34
68
  alignItemsAtEnd?: boolean;
35
69
  /**
36
- * Style applied to each column's wrapper view.
70
+ * If true, enables using average sizes for performance optimization.
71
+ * @default true
37
72
  */
38
- columnWrapperStyle?: ColumnWrapperStyle;
73
+ enableAverages?: boolean;
39
74
  /**
40
- * Array of items to render in the list.
41
- * @required
75
+ * Style applied to each column's wrapper view.
42
76
  */
43
- data: ReadonlyArray<ItemT>;
77
+ columnWrapperStyle?: ColumnWrapperStyle;
44
78
  /**
45
79
  * Distance in pixels to pre-render items ahead of the visible area.
46
80
  * @default 250
@@ -68,7 +102,7 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
68
102
  * In case you have distinct item sizes, you can provide a function to get the size of an item.
69
103
  * Use instead of FlatList's getItemLayout or FlashList overrideItemLayout if you want to have accurate initialScrollOffset, you should provide this function
70
104
  */
71
- getEstimatedItemSize?: (index: number, item: ItemT) => number;
105
+ getEstimatedItemSize?: (index: number, item: ItemT, type: TItemType) => number;
72
106
  /**
73
107
  * Ratio of initial container pool size to data length (e.g., 0.5 for half).
74
108
  * @default 2
@@ -86,7 +120,6 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
86
120
  initialScrollIndex?: number | {
87
121
  index: number;
88
122
  viewOffset?: number | undefined;
89
- viewPosition?: number | undefined;
90
123
  };
91
124
  /**
92
125
  * Component to render between items, receiving the leading item as prop.
@@ -163,6 +196,7 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
163
196
  * Function to call when the user pulls to refresh.
164
197
  */
165
198
  onRefresh?: () => void;
199
+ onScroll?: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
166
200
  /**
167
201
  * Called when scrolling reaches the start within onStartReachedThreshold.
168
202
  */
@@ -177,7 +211,7 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
177
211
  /**
178
212
  * Called when the viewability of items changes.
179
213
  */
180
- onViewableItemsChanged?: OnViewableItemsChanged | undefined;
214
+ onViewableItemsChanged?: OnViewableItemsChanged<ItemT> | undefined;
181
215
  /**
182
216
  * Offset in pixels for the refresh indicator.
183
217
  * @default 0
@@ -197,14 +231,6 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
197
231
  * @default false
198
232
  */
199
233
  refreshing?: boolean;
200
- /**
201
- * Function or React component to render each item in the list.
202
- * Can be either:
203
- * - A function: (props: LegendListRenderItemProps<ItemT>) => ReactNode
204
- * - A React component: React.ComponentType<LegendListRenderItemProps<ItemT>>
205
- * @required
206
- */
207
- renderItem?: ((props: LegendListRenderItemProps<ItemT>) => ReactNode) | React.ComponentType<LegendListRenderItemProps<ItemT>>;
208
234
  /**
209
235
  * Render custom ScrollView component.
210
236
  * @default (props) => <ScrollView {...props} />
@@ -223,7 +249,7 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
223
249
  /**
224
250
  * Pairs of viewability configs and their callbacks for tracking visibility.
225
251
  */
226
- viewabilityConfigCallbackPairs?: ViewabilityConfigCallbackPairs | undefined;
252
+ viewabilityConfigCallbackPairs?: ViewabilityConfigCallbackPairs<ItemT> | undefined;
227
253
  /**
228
254
  * If true, delays rendering until initial layout is complete.
229
255
  * @default false
@@ -233,7 +259,18 @@ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof Scroll
233
259
  elapsedTimeInMs: number;
234
260
  }) => void;
235
261
  snapToIndices?: number[];
236
- };
262
+ /**
263
+ * Array of child indices determining which children get docked to the top of the screen when scrolling.
264
+ * For example, passing stickyIndices={[0]} will cause the first child to be fixed to the top of the scroll view.
265
+ * Not supported in conjunction with horizontal={true}.
266
+ * @default undefined
267
+ */
268
+ stickyIndices?: number[];
269
+ getItemType?: (item: ItemT, index: number) => TItemType;
270
+ getFixedItemSize?: (index: number, item: ItemT, type: TItemType) => number;
271
+ itemsAreEqual?: (itemPrevious: ItemT, item: ItemT, index: number, data: readonly ItemT[]) => boolean;
272
+ }
273
+ type LegendListPropsBase<ItemT, TScrollView extends ComponentProps<typeof ScrollView> | ComponentProps<typeof Animated.ScrollView> | ComponentProps<typeof Animated$1.ScrollView>, TItemType extends string | undefined = string | undefined> = BaseScrollViewProps<TScrollView> & LegendListSpecificProps<ItemT, TItemType> & (DataModeProps<ItemT, TItemType> | ChildrenModeProps);
237
274
  interface MaintainScrollAtEndOptions {
238
275
  onLayout?: boolean;
239
276
  onItemLayout?: boolean;
@@ -244,14 +281,14 @@ interface ColumnWrapperStyle {
244
281
  gap?: number;
245
282
  columnGap?: number;
246
283
  }
247
- type LegendListProps<ItemT> = LegendListPropsBase<ItemT, Omit<ComponentProps<typeof ScrollView>, "scrollEventThrottle">>;
284
+ type LegendListProps<ItemT = any> = LegendListPropsBase<ItemT, ComponentProps<typeof ScrollView>>;
248
285
  interface InternalState {
249
286
  positions: Map<string, number>;
250
287
  columns: Map<string, number>;
251
288
  sizes: Map<string, number>;
252
289
  sizesKnown: Map<string, number>;
253
290
  containerItemKeys: Set<string>;
254
- pendingAdjust: number;
291
+ containerItemTypes: Map<number, string>;
255
292
  isStartReached: boolean;
256
293
  isEndReached: boolean;
257
294
  isAtEnd: boolean;
@@ -279,7 +316,7 @@ interface InternalState {
279
316
  nativeMarginTop: number;
280
317
  indexByKey: Map<string, number>;
281
318
  idCache: Map<number, string>;
282
- viewabilityConfigCallbackPairs: ViewabilityConfigCallbackPairs | undefined;
319
+ viewabilityConfigCallbackPairs: ViewabilityConfigCallbackPairs<any> | undefined;
283
320
  scrollHistory: Array<{
284
321
  scroll: number;
285
322
  time: number;
@@ -314,59 +351,46 @@ interface InternalState {
314
351
  }>;
315
352
  refScroller: React.RefObject<ScrollView>;
316
353
  loadStartTime: number;
317
- initialScroll: ScrollIndexWithOffsetPosition | undefined;
354
+ initialScroll: ScrollIndexWithOffset | undefined;
318
355
  lastLayout: LayoutRectangle | undefined;
319
- queuedItemSizeUpdates: {
320
- itemKey: string;
321
- sizeObj: {
322
- width: number;
323
- height: number;
324
- };
325
- }[];
326
- queuedItemSizeUpdatesWaiting?: boolean;
327
356
  timeoutSetPaddingTop?: any;
357
+ activeStickyIndex: number | undefined;
358
+ stickyContainers: Map<number, number>;
359
+ stickyContainerPool: Set<number>;
360
+ scrollProcessingEnabled: boolean;
328
361
  props: {
329
362
  alignItemsAtEnd: boolean;
330
363
  data: readonly any[];
331
364
  estimatedItemSize: number | undefined;
332
- getEstimatedItemSize: ((index: number, item: any) => number) | undefined;
365
+ getEstimatedItemSize: LegendListProps["getEstimatedItemSize"];
366
+ getFixedItemSize: LegendListProps["getFixedItemSize"];
367
+ getItemType: LegendListProps["getItemType"];
333
368
  horizontal: boolean;
334
- keyExtractor: ((item: any, index: number) => string) | undefined;
369
+ keyExtractor: LegendListProps["keyExtractor"];
335
370
  maintainScrollAtEnd: boolean | MaintainScrollAtEndOptions;
336
371
  maintainScrollAtEndThreshold: number | undefined;
337
372
  maintainVisibleContentPosition: boolean;
338
- onEndReached: (((info: {
339
- distanceFromEnd: number;
340
- }) => void) | null | undefined) | undefined;
373
+ onEndReached: LegendListProps["onEndReached"];
341
374
  onEndReachedThreshold: number | null | undefined;
342
- onItemSizeChanged: ((info: {
343
- size: number;
344
- previous: number;
345
- index: number;
346
- itemKey: string;
347
- itemData: any;
348
- }) => void) | undefined;
349
- onLoad: ((info: {
350
- elapsedTimeInMs: number;
351
- }) => void) | undefined;
352
- onScroll: ((event: NativeSyntheticEvent<NativeScrollEvent>) => void) | undefined;
353
- onStartReached: (((info: {
354
- distanceFromStart: number;
355
- }) => void) | null | undefined) | undefined;
375
+ onItemSizeChanged: LegendListProps["onItemSizeChanged"];
376
+ onLoad: LegendListProps["onLoad"];
377
+ onScroll: LegendListProps["onScroll"];
378
+ onStartReached: LegendListProps["onStartReached"];
356
379
  onStartReachedThreshold: number | null | undefined;
380
+ recycleItems: boolean;
357
381
  suggestEstimatedItemSize: boolean;
358
382
  stylePaddingBottom: number | undefined;
359
- renderItem: ((props: LegendListRenderItemProps<any>) => ReactNode) | React.ComponentType<LegendListRenderItemProps<any>>;
360
- initialScroll: {
361
- index: number;
362
- viewOffset?: number;
363
- viewPosition?: number;
364
- } | undefined;
383
+ renderItem: LegendListProps["renderItem"];
384
+ initialScroll: ScrollIndexWithOffset | undefined;
365
385
  scrollBuffer: number;
366
386
  numColumns: number;
367
387
  initialContainerPoolRatio: number;
368
388
  stylePaddingTop: number | undefined;
369
389
  snapToIndices: number[] | undefined;
390
+ stickyIndicesSet: Set<number>;
391
+ stickyIndicesArr: number[];
392
+ itemsAreEqual: LegendListProps["itemsAreEqual"];
393
+ enableAverages: boolean;
370
394
  };
371
395
  }
372
396
  interface ViewableRange<T> {
@@ -376,24 +400,28 @@ interface ViewableRange<T> {
376
400
  end: number;
377
401
  items: T[];
378
402
  }
379
- interface LegendListRenderItemProps<ItemT> {
403
+ interface LegendListRenderItemProps<ItemT, TItemType extends string | number | undefined = string | number | undefined> {
380
404
  item: ItemT;
405
+ type: TItemType;
381
406
  index: number;
407
+ data: readonly ItemT[];
382
408
  extraData: any;
383
409
  }
384
410
  type ScrollState = {
385
411
  contentLength: number;
412
+ data: readonly any[];
386
413
  end: number;
387
414
  endBuffered: number;
388
415
  isAtEnd: boolean;
389
416
  isAtStart: boolean;
417
+ positionAtIndex: (index: number) => number;
390
418
  positions: Map<string, number>;
391
419
  scroll: number;
392
420
  scrollLength: number;
421
+ sizeAtIndex: (index: number) => number;
422
+ sizes: Map<string, number>;
393
423
  start: number;
394
424
  startBuffered: number;
395
- sizes: Map<string, number>;
396
- sizeAtIndex: (index: number) => number;
397
425
  };
398
426
  type LegendListRef = {
399
427
  /**
@@ -440,9 +468,11 @@ type LegendListRef = {
440
468
  * Scrolls to the end of the list.
441
469
  * @param options - Options for scrolling.
442
470
  * @param options.animated - If true, animates the scroll. Default: true.
471
+ * @param options.viewOffset - Offset from the target position.
443
472
  */
444
473
  scrollToEnd(options?: {
445
474
  animated?: boolean | undefined;
475
+ viewOffset?: number | undefined;
446
476
  }): void;
447
477
  /**
448
478
  * Scrolls to a specific index in the list.
@@ -488,6 +518,11 @@ type LegendListRef = {
488
518
  * @param animated - If true, uses Animated to animate the change.
489
519
  */
490
520
  setVisibleContentAnchorOffset(value: number | ((value: number) => number)): void;
521
+ /**
522
+ * Sets whether scroll processing is enabled.
523
+ * @param enabled - If true, scroll processing is enabled.
524
+ */
525
+ setScrollProcessingEnabled(enabled: boolean): void;
491
526
  };
492
527
  interface ViewToken<ItemT = any> {
493
528
  item: ItemT;
@@ -503,14 +538,14 @@ interface ViewAmountToken<ItemT = any> extends ViewToken<ItemT> {
503
538
  percentOfScroller: number;
504
539
  scrollSize: number;
505
540
  }
506
- interface ViewabilityConfigCallbackPair {
541
+ interface ViewabilityConfigCallbackPair<ItemT> {
507
542
  viewabilityConfig: ViewabilityConfig;
508
- onViewableItemsChanged?: OnViewableItemsChanged;
543
+ onViewableItemsChanged?: OnViewableItemsChanged<ItemT>;
509
544
  }
510
- type ViewabilityConfigCallbackPairs = ViewabilityConfigCallbackPair[];
511
- type OnViewableItemsChanged = ((info: {
512
- viewableItems: Array<ViewToken>;
513
- changed: Array<ViewToken>;
545
+ type ViewabilityConfigCallbackPairs<ItemT> = ViewabilityConfigCallbackPair<ItemT>[];
546
+ type OnViewableItemsChanged<ItemT> = ((info: {
547
+ viewableItems: Array<ViewToken<ItemT>>;
548
+ changed: Array<ViewToken<ItemT>>;
514
549
  }) => void) | null;
515
550
  interface ViewabilityConfig {
516
551
  /**
@@ -541,8 +576,8 @@ interface ViewabilityConfig {
541
576
  */
542
577
  waitForInteraction?: boolean | undefined;
543
578
  }
544
- type ViewabilityCallback = (viewToken: ViewToken) => void;
545
- type ViewabilityAmountCallback = (viewToken: ViewAmountToken) => void;
579
+ type ViewabilityCallback<ItemT = any> = (viewToken: ViewToken<ItemT>) => void;
580
+ type ViewabilityAmountCallback<ItemT = any> = (viewToken: ViewAmountToken<ItemT>) => void;
546
581
  interface LegendListRecyclingState<T> {
547
582
  item: T;
548
583
  prevItem: T | undefined;
@@ -555,11 +590,13 @@ type TypedMemo = <T extends React.ComponentType<any>>(Component: T, propsAreEqua
555
590
  displayName?: string;
556
591
  };
557
592
  declare const typedMemo: TypedMemo;
558
- type ScrollIndexWithOffsetPosition = {
593
+ interface ScrollIndexWithOffset {
559
594
  index: number;
560
- viewOffset?: number;
561
- viewPosition?: number;
562
- };
595
+ viewOffset: number;
596
+ }
597
+ interface ScrollIndexWithOffsetPosition extends ScrollIndexWithOffset {
598
+ viewPosition: number;
599
+ }
563
600
  type GetRenderedItemResult<ItemT> = {
564
601
  index: number;
565
602
  item: ItemT;
@@ -567,270 +604,12 @@ type GetRenderedItemResult<ItemT> = {
567
604
  };
568
605
  type GetRenderedItem = (key: string) => GetRenderedItemResult<any> | null;
569
606
 
570
- interface LazyLegendListProps<ItemT, ListT> extends Omit<LegendListProps<ItemT>, "data" | "keyExtractor" | "renderItem"> {
571
- children?: React$1.ReactNode | undefined;
572
- LegendList?: ListT;
573
- }
574
- declare const LazyLegendList: <ItemT, ListT extends (<T>(props: Omit<Omit<react_native.ScrollViewProps, "scrollEventThrottle">, "contentOffset" | "contentInset" | "maintainVisibleContentPosition" | "stickyHeaderIndices" | "removeClippedSubviews" | "children"> & {
575
- alignItemsAtEnd?: boolean;
576
- columnWrapperStyle?: ColumnWrapperStyle;
577
- data: readonly T[];
578
- drawDistance?: number;
579
- estimatedItemSize?: number;
580
- estimatedListSize?: {
581
- height: number;
582
- width: number;
583
- };
584
- extraData?: any;
585
- getEstimatedItemSize?: ((index: number, item: T) => number) | undefined;
586
- initialContainerPoolRatio?: number | undefined;
587
- initialScrollOffset?: number;
588
- initialScrollIndex?: number | {
589
- index: number;
590
- viewOffset?: number | undefined;
591
- viewPosition?: number | undefined;
592
- };
593
- ItemSeparatorComponent?: React$1.ComponentType<{
594
- leadingItem: T;
595
- }> | undefined;
596
- keyExtractor?: ((item: T, index: number) => string) | undefined;
597
- ListEmptyComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
598
- ListFooterComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
599
- ListFooterComponentStyle?: react_native.StyleProp<react_native.ViewStyle> | undefined;
600
- ListHeaderComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
601
- ListHeaderComponentStyle?: react_native.StyleProp<react_native.ViewStyle> | undefined;
602
- maintainScrollAtEnd?: boolean | MaintainScrollAtEndOptions;
603
- maintainScrollAtEndThreshold?: number;
604
- maintainVisibleContentPosition?: boolean;
605
- numColumns?: number;
606
- onEndReached?: ((info: {
607
- distanceFromEnd: number;
608
- }) => void) | null | undefined;
609
- onEndReachedThreshold?: number | null | undefined;
610
- onItemSizeChanged?: ((info: {
611
- size: number;
612
- previous: number;
613
- index: number;
614
- itemKey: string;
615
- itemData: T;
616
- }) => void) | undefined;
617
- onRefresh?: () => void;
618
- onStartReached?: ((info: {
619
- distanceFromStart: number;
620
- }) => void) | null | undefined;
621
- onStartReachedThreshold?: number | null | undefined;
622
- onViewableItemsChanged?: OnViewableItemsChanged | undefined;
623
- progressViewOffset?: number;
624
- recycleItems?: boolean;
625
- refScrollView?: React$1.Ref<react_native.ScrollView>;
626
- refreshing?: boolean;
627
- renderItem?: ((props: LegendListRenderItemProps<T>) => React$1.ReactNode) | React$1.ComponentType<LegendListRenderItemProps<T>> | undefined;
628
- renderScrollComponent?: (props: react_native.ScrollViewProps) => React$1.ReactElement<react_native.ScrollViewProps>;
629
- suggestEstimatedItemSize?: boolean;
630
- viewabilityConfig?: ViewabilityConfig;
631
- viewabilityConfigCallbackPairs?: ViewabilityConfigCallbackPairs | undefined;
632
- waitForInitialLayout?: boolean;
633
- onLoad?: (info: {
634
- elapsedTimeInMs: number;
635
- }) => void;
636
- snapToIndices?: number[];
637
- } & React$1.RefAttributes<LegendListRef>) => React$1.ReactNode) | react_native.Animated.AnimatedComponent<(<T>(props: Omit<Omit<react_native.ScrollViewProps, "scrollEventThrottle">, "contentOffset" | "contentInset" | "maintainVisibleContentPosition" | "stickyHeaderIndices" | "removeClippedSubviews" | "children"> & {
638
- alignItemsAtEnd?: boolean;
639
- columnWrapperStyle?: ColumnWrapperStyle;
640
- data: readonly T[];
641
- drawDistance?: number;
642
- estimatedItemSize?: number;
643
- estimatedListSize?: {
644
- height: number;
645
- width: number;
646
- };
647
- extraData?: any;
648
- getEstimatedItemSize?: ((index: number, item: T) => number) | undefined;
649
- initialContainerPoolRatio?: number | undefined;
650
- initialScrollOffset?: number;
651
- initialScrollIndex?: number | {
652
- index: number;
653
- viewOffset?: number | undefined;
654
- viewPosition?: number | undefined;
655
- };
656
- ItemSeparatorComponent?: React$1.ComponentType<{
657
- leadingItem: T;
658
- }> | undefined;
659
- keyExtractor?: ((item: T, index: number) => string) | undefined;
660
- ListEmptyComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
661
- ListFooterComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
662
- ListFooterComponentStyle?: react_native.StyleProp<react_native.ViewStyle> | undefined;
663
- ListHeaderComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
664
- ListHeaderComponentStyle?: react_native.StyleProp<react_native.ViewStyle> | undefined;
665
- maintainScrollAtEnd?: boolean | MaintainScrollAtEndOptions;
666
- maintainScrollAtEndThreshold?: number;
667
- maintainVisibleContentPosition?: boolean;
668
- numColumns?: number;
669
- onEndReached?: ((info: {
670
- distanceFromEnd: number;
671
- }) => void) | null | undefined;
672
- onEndReachedThreshold?: number | null | undefined;
673
- onItemSizeChanged?: ((info: {
674
- size: number;
675
- previous: number;
676
- index: number;
677
- itemKey: string;
678
- itemData: T;
679
- }) => void) | undefined;
680
- onRefresh?: () => void;
681
- onStartReached?: ((info: {
682
- distanceFromStart: number;
683
- }) => void) | null | undefined;
684
- onStartReachedThreshold?: number | null | undefined;
685
- onViewableItemsChanged?: OnViewableItemsChanged | undefined;
686
- progressViewOffset?: number;
687
- recycleItems?: boolean;
688
- refScrollView?: React$1.Ref<react_native.ScrollView>;
689
- refreshing?: boolean;
690
- renderItem?: ((props: LegendListRenderItemProps<T>) => React$1.ReactNode) | React$1.ComponentType<LegendListRenderItemProps<T>> | undefined;
691
- renderScrollComponent?: (props: react_native.ScrollViewProps) => React$1.ReactElement<react_native.ScrollViewProps>;
692
- suggestEstimatedItemSize?: boolean;
693
- viewabilityConfig?: ViewabilityConfig;
694
- viewabilityConfigCallbackPairs?: ViewabilityConfigCallbackPairs | undefined;
695
- waitForInitialLayout?: boolean;
696
- onLoad?: (info: {
697
- elapsedTimeInMs: number;
698
- }) => void;
699
- snapToIndices?: number[];
700
- } & React$1.RefAttributes<LegendListRef>) => React$1.ReactNode)> | (<ItemT_1>(props: _legendapp_list_reanimated.AnimatedLegendListProps<ItemT_1> & {
701
- ref?: React$1.Ref<LegendListRef>;
702
- }) => React$1.ReactElement | null) = <T>(props: Omit<Omit<react_native.ScrollViewProps, "scrollEventThrottle">, "contentOffset" | "contentInset" | "maintainVisibleContentPosition" | "stickyHeaderIndices" | "removeClippedSubviews" | "children"> & {
703
- alignItemsAtEnd?: boolean;
704
- columnWrapperStyle?: ColumnWrapperStyle;
705
- data: readonly T[];
706
- drawDistance?: number;
707
- estimatedItemSize?: number;
708
- estimatedListSize?: {
709
- height: number;
710
- width: number;
711
- };
712
- extraData?: any;
713
- getEstimatedItemSize?: ((index: number, item: T) => number) | undefined;
714
- initialContainerPoolRatio?: number | undefined;
715
- initialScrollOffset?: number;
716
- initialScrollIndex?: number | {
717
- index: number;
718
- viewOffset?: number | undefined;
719
- viewPosition?: number | undefined;
720
- };
721
- ItemSeparatorComponent?: React$1.ComponentType<{
722
- leadingItem: T;
723
- }> | undefined;
724
- keyExtractor?: ((item: T, index: number) => string) | undefined;
725
- ListEmptyComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
726
- ListFooterComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
727
- ListFooterComponentStyle?: react_native.StyleProp<react_native.ViewStyle> | undefined;
728
- ListHeaderComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
729
- ListHeaderComponentStyle?: react_native.StyleProp<react_native.ViewStyle> | undefined;
730
- maintainScrollAtEnd?: boolean | MaintainScrollAtEndOptions;
731
- maintainScrollAtEndThreshold?: number;
732
- maintainVisibleContentPosition?: boolean;
733
- numColumns?: number;
734
- onEndReached?: ((info: {
735
- distanceFromEnd: number;
736
- }) => void) | null | undefined;
737
- onEndReachedThreshold?: number | null | undefined;
738
- onItemSizeChanged?: ((info: {
739
- size: number;
740
- previous: number;
741
- index: number;
742
- itemKey: string;
743
- itemData: T;
744
- }) => void) | undefined;
745
- onRefresh?: () => void;
746
- onStartReached?: ((info: {
747
- distanceFromStart: number;
748
- }) => void) | null | undefined;
749
- onStartReachedThreshold?: number | null | undefined;
750
- onViewableItemsChanged?: OnViewableItemsChanged | undefined;
751
- progressViewOffset?: number;
752
- recycleItems?: boolean;
753
- refScrollView?: React$1.Ref<react_native.ScrollView>;
754
- refreshing?: boolean;
755
- renderItem?: ((props: LegendListRenderItemProps<T>) => React$1.ReactNode) | React$1.ComponentType<LegendListRenderItemProps<T>> | undefined;
756
- renderScrollComponent?: (props: react_native.ScrollViewProps) => React$1.ReactElement<react_native.ScrollViewProps>;
757
- suggestEstimatedItemSize?: boolean;
758
- viewabilityConfig?: ViewabilityConfig;
759
- viewabilityConfigCallbackPairs?: ViewabilityConfigCallbackPairs | undefined;
760
- waitForInitialLayout?: boolean;
761
- onLoad?: (info: {
762
- elapsedTimeInMs: number;
763
- }) => void;
764
- snapToIndices?: number[];
765
- } & React$1.RefAttributes<LegendListRef>) => React$1.ReactNode>(props: LazyLegendListProps<ItemT, ListT> & React$1.RefAttributes<LegendListRef>) => React$1.ReactNode;
766
-
767
- declare const LegendList: <T>(props: Omit<Omit<react_native.ScrollViewProps, "scrollEventThrottle">, "contentOffset" | "contentInset" | "maintainVisibleContentPosition" | "stickyHeaderIndices" | "removeClippedSubviews" | "children"> & {
768
- alignItemsAtEnd?: boolean;
769
- columnWrapperStyle?: ColumnWrapperStyle;
770
- data: readonly T[];
771
- drawDistance?: number;
772
- estimatedItemSize?: number;
773
- estimatedListSize?: {
774
- height: number;
775
- width: number;
776
- };
777
- extraData?: any;
778
- getEstimatedItemSize?: ((index: number, item: T) => number) | undefined;
779
- initialContainerPoolRatio?: number | undefined;
780
- initialScrollOffset?: number;
781
- initialScrollIndex?: number | {
782
- index: number;
783
- viewOffset?: number | undefined;
784
- viewPosition?: number | undefined;
785
- };
786
- ItemSeparatorComponent?: React$1.ComponentType<{
787
- leadingItem: T;
788
- }> | undefined;
789
- keyExtractor?: ((item: T, index: number) => string) | undefined;
790
- ListEmptyComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
791
- ListFooterComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
792
- ListFooterComponentStyle?: react_native.StyleProp<react_native.ViewStyle> | undefined;
793
- ListHeaderComponent?: React$1.ComponentType<any> | React$1.ReactElement | null | undefined;
794
- ListHeaderComponentStyle?: react_native.StyleProp<react_native.ViewStyle> | undefined;
795
- maintainScrollAtEnd?: boolean | MaintainScrollAtEndOptions;
796
- maintainScrollAtEndThreshold?: number;
797
- maintainVisibleContentPosition?: boolean;
798
- numColumns?: number;
799
- onEndReached?: ((info: {
800
- distanceFromEnd: number;
801
- }) => void) | null | undefined;
802
- onEndReachedThreshold?: number | null | undefined;
803
- onItemSizeChanged?: ((info: {
804
- size: number;
805
- previous: number;
806
- index: number;
807
- itemKey: string;
808
- itemData: T;
809
- }) => void) | undefined;
810
- onRefresh?: () => void;
811
- onStartReached?: ((info: {
812
- distanceFromStart: number;
813
- }) => void) | null | undefined;
814
- onStartReachedThreshold?: number | null | undefined;
815
- onViewableItemsChanged?: OnViewableItemsChanged | undefined;
816
- progressViewOffset?: number;
817
- recycleItems?: boolean;
818
- refScrollView?: React$1.Ref<ScrollView>;
819
- refreshing?: boolean;
820
- renderItem?: ((props: LegendListRenderItemProps<T>) => React$1.ReactNode) | React$1.ComponentType<LegendListRenderItemProps<T>> | undefined;
821
- renderScrollComponent?: (props: react_native.ScrollViewProps) => React$1.ReactElement<react_native.ScrollViewProps>;
822
- suggestEstimatedItemSize?: boolean;
823
- viewabilityConfig?: ViewabilityConfig;
824
- viewabilityConfigCallbackPairs?: ViewabilityConfigCallbackPairs | undefined;
825
- waitForInitialLayout?: boolean;
826
- onLoad?: (info: {
827
- elapsedTimeInMs: number;
828
- }) => void;
829
- snapToIndices?: number[];
830
- } & React$1.RefAttributes<LegendListRef>) => React$1.ReactNode;
607
+ declare const LegendList: (<T>(props: LegendListProps<T> & React$1.RefAttributes<LegendListRef>) => React$1.ReactNode) & {
608
+ displayName?: string;
609
+ };
831
610
 
832
- declare function useViewability(callback: ViewabilityCallback, configId?: string): void;
833
- declare function useViewabilityAmount(callback: ViewabilityAmountCallback): void;
611
+ declare function useViewability<ItemT = any>(callback: ViewabilityCallback<ItemT>, configId?: string): void;
612
+ declare function useViewabilityAmount<ItemT = any>(callback: ViewabilityAmountCallback<ItemT>): void;
834
613
  declare function useRecyclingEffect(effect: (info: LegendListRecyclingState<unknown>) => void | (() => void)): void;
835
614
  declare function useRecyclingState<ItemT>(valueOrFun: ((info: LegendListRecyclingState<ItemT>) => ItemT) | ItemT): readonly [ItemT | null, Dispatch<SetStateAction<ItemT>>];
836
615
  declare function useIsLastItem(): boolean;
@@ -838,5 +617,6 @@ declare function useListScrollSize(): {
838
617
  width: number;
839
618
  height: number;
840
619
  };
620
+ declare function useSyncLayout(): () => void;
841
621
 
842
- export { type ColumnWrapperStyle, type GetRenderedItem, type GetRenderedItemResult, type InternalState, LazyLegendList, type LazyLegendListProps, LegendList, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type MaintainScrollAtEndOptions, type OnViewableItemsChanged, type ScrollIndexWithOffsetPosition, 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, useListScrollSize, useRecyclingEffect, useRecyclingState, useViewability, useViewabilityAmount };
622
+ export { type ColumnWrapperStyle, type GetRenderedItem, type GetRenderedItemResult, type InternalState, LegendList, type LegendListProps, type LegendListPropsBase, type LegendListRecyclingState, type LegendListRef, type LegendListRenderItemProps, type MaintainScrollAtEndOptions, type OnViewableItemsChanged, type ScrollIndexWithOffset, type ScrollIndexWithOffsetPosition, 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, useListScrollSize, useRecyclingEffect, useRecyclingState, useSyncLayout, useViewability, useViewabilityAmount };