Interface UseVirtualRowsResult

interface UseVirtualRowsResult {
    onScroll: (event: { currentTarget: HTMLElement }) => void;
    scrollTopRef: RefObject<number>;
    setViewportHeight: (height: number) => void;
    totalHeight: number;
    window: VirtualWindow;
}

Properties

onScroll: (event: { currentTarget: HTMLElement }) => void

Attach to the scrolling element's onScroll.

scrollTopRef: RefObject<number>

Live scroll offset, readable without causing a re-render.

setViewportHeight: (height: number) => void

Call when the viewport is measured or resized.

totalHeight: number

rowCount * rowHeight — the spacer height that gives the correct scrollbar.

The rows to render right now.