Interface Virtualizer

A value returned from the useVirtualizer hook.

interface Virtualizer {
    items: readonly VirtualItem[];
    estimateItemSize(index: number): number;
    estimateTotalSize(): number;
    scrollToIndex(
        index: number,
        options?: VirtualizerScrollToIndexOptions,
    ): void;
    scrollToPosition(position: number): void;
}

Index

Properties

Methods

estimateItemSize estimateTotalSize scrollToIndex scrollToPosition

Properties

items

items: readonly VirtualItem[]

The items to render.

Note: Items in this array may be reused between re-renders.

Methods

estimateItemSize

estimateItemSize(index: number): number
Returns an estimated item size, in pixels, along the scroll axis, or the most recently measured item size if the item has been rendered before.
Parameters
- index: number
  The item index.
Returns number

estimateTotalSize

estimateTotalSize(): number
Returns an estimated total size of the virtualized list, in pixels, along the scroll axis, based on the total number of items and an estimated average item size.

Returns number

scrollToIndex

scrollToIndex(index: number, options?: VirtualizerScrollToIndexOptions): void
Scrolls the virtualizer to the item with the given index.
Parameters
- index: number
  The item index.
- Optionaloptions: VirtualizerScrollToIndexOptions
  Scroll options.
Returns void

scrollToPosition

scrollToPosition(position: number): void
Scrolls the virtualizer to an absolute position.

Note: Scroll position precision is not guaranteed if estimateTotalSize is greater than NumberConstructor.MAX_SAFE_INTEGER.
Parameters
- position: number
  The scroll position, in pixels.
Returns void