Interface ViewProps

Setting alignToBottom to true aligns the items to the bottom of the list if the list is shorter than the viewport. Use followOutput property to keep the list aligned when new items are appended.

Called with true / false when the list has reached the bottom / gets scrolled up. Can be used to load newer items, like tail -f.

The property accepts pixel values.

By default 4. Redefine to change how much away from the bottom the scroller can be before the list is not considered not at bottom.

Called with true / false when the list has reached the top / gets scrolled down.

The property accepts pixel values.

By default 0. Redefine to change how much away from the top the scroller can be before the list is not considered not at top.

Use the components property for advanced customization of the elements rendered by the list.

If specified, the component will use the function to generate the key property for each list item.

Additional context available in the custom components and content callbacks

Pass a reference to a scrollable parent element, so that the list won't wrap in its own.

The data items to be rendered. If data is set, the total count will be inferred from the length of the array.

By default, the component assumes the default item height from the first rendered item (rendering it as a "probe").

If the first item turns out to be an outlier (very short or tall), the rest of the rendering will be slower, as multiple passes of rendering should happen for the list to fill the viewport.

Setting defaultItemHeight causes the component to skip the "probe" rendering and use the property value as default height instead.

Gets called when the user scrolls to the end of the list. Receives the last item index as an argument. Can be used to implement endless scrolling.

Use when implementing inverse infinite scrolling - decrease the value this property in combination with data or totalCount to prepend items to the top of the list.

Warning: the firstItemIndex should be a positive number, based on the total amount of items to be displayed.

Can be used to improve performance if the rendered items are of known size. Setting it causes the component to skip item measurements.

If set to true, the list automatically scrolls to bottom if the total count is changed. Set to "smooth" for an animated scrolling.

By default, followOutput scrolls down only if the list is already at the bottom. To implement an arbitrary logic behind that, pass a function:

<Virtuoso
 followOutput={(isAtBottom: boolean) => {
   if (expression) {
     return 'smooth' // can be 'auto' or false to avoid scrolling
   } else {
     return false
   }
 }} />
Copy

Set to customize the wrapper tag for the header and footer components (default is div).

The property accepts pixel values.

Set the increaseViewportBy property to artificially increase the viewport size, causing items to be rendered before outside of the viewport. The property causes the component to render more items than the necessary, but can help with slow loading content. Using { top?: number, bottom?: number } lets you set the increase for each end separately.

Use for server-side rendering - if set, the list will render the specified amount of items regardless of the container / item size.

Set this value to offset the initial location of the list. Warning: using this property will still run a render cycle at the scrollTop: 0 list window. If possible, avoid using it and stick to initialTopMostItemIndex instead.

Set to a value between 0 and totalCount - 1 to make the list start scrolled to that item. Pass in an object to achieve additional effects similar to scrollToIndex.

Called when the list starts/stops scrolling.

Set the callback to specify the contents of the item.

Allows customizing the height/width calculation of Item elements.

The default implementation reads el.getBoundingClientRect().height and el.getBoundingClientRect().width.

Called with the new set of items each time the list items are rendered due to scrolling.

The property accepts pixel values.

Set the overscan property to make the component "chunk" the rendering of new items on scroll. The property causes the component to render more items than the necessary, but reduces the re-renders on scroll. Setting { main: number, reverse: number } lets you extend the list in both the main and the reverse scrollable directions. See the increaseViewportBy property for a similar behavior (equivalent to the overscan in react-window).

Called with the new set of items each time the list items are rendered due to scrolling.

No longer necessary after 2.10.2. component should work out of the box.

Provides access to the root DOM element

Use to display placeholders if the user scrolls fast through the list.

Set components.ScrollSeekPlaceholder to change the placeholder content.

Called when the user scrolls to the start of the list.

Set the amount of items to remain fixed at the top of the list.

For a header that scrolls away when scrolling, check the components.Header property.

The total amount of items to be rendered.

Called when the total list height is changed due to new items or viewport resize.

Uses the document scroller rather than wrapping the list in its own.