Component used as a template to render items in the list. Must implement DisplayListItem interface.
OptionalclassThe className applied to the outer container element. Use when styling the entire component.
Component height
OptionalinnerThe className applied to the inner container element. Use for special cases when styling only the inner container and items.
OptionalinnerRender prop implementing VirtualContainerRender. Used to customize DisplayList within VirtualList inner container.
Number of items in the list
OptionalitemPassed as DisplayBaseItemProps.data to each child item
OptionalitemFunction that defines the key to use for each item given item index and value of VirtualBaseProps.itemData.
Implementation of ItemOffsetMapping interface that defines size and offset to each item in the list
Use useFixedSizeItemOffsetMapping or useVariableSizeItemOffsetMapping to create implementations for common cases.
OptionallayoutChoice of 'vertical' or 'horizontal' layouts
OptionalmaxMaximum size for CSS element beyond which layout breaks. You should never normally need to change this. The default value is compatible with all major browsers.
OptionalminThe minimum number of virtual pages to use when inner container would otherwise be more than VirtualScrollableProps.maxCssSize big. You should never normally need to change this.
OptionalonCallback after a scroll event has been processed and state updated but before rendering
Resulting overall offset. Can be passed to ItemOffsetMapping to determine top item.
New ScrollState that will be used for rendering.
OptionalouterRender prop implementing VirtualContainerRender. Used to customize VirtualList outer container.
OptionaluseDetermines whether the component should track whether it's being actively scrolled and pass through when rendering its content.
Component width
Props accepted by VirtualList