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[]

An array of 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 latest measured item size if item was previously rendered.
Parameters
- index: number
  An index of an item.
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 virtualizer to an item with the given index.
Parameters
- index: number
  An index of an item.
- Optionaloptions: VirtualizerScrollToIndexOptions
  Scroll options.
Returns void

scrollToPosition

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

Note: The precision of the scroll position isn't guaranteed if an estimateTotalSize is greater then NumberConstructor.MAX_SAFE_INTEGER.
Parameters
- position: number
  A position in pixels to scroll to.
Returns void