Repository files navigation

A tiny but mighty list virtualization library, with zero dependencies 💪

• Tiny & dependency free – Only 3kb gzipped
• Render millions of items, without breaking a sweat
• Scroll to index orset the initial scroll offset
• Supports fixed orvariable heights/widths
• Vertical orHorizontal lists

Check out thedemo for some examples, or take it for a test drive right away inCode Sandbox.

Usingnpm:

npm install react-tiny-virtual-list --save

ES6, CommonJS, and UMD builds are available with each distribution. For example:

importVirtualListfrom'react-tiny-virtual-list';

You can also use a global-friendly UMD build:

<scriptsrc="react-tiny-virtual-list/umd/react-tiny-virtual-list.js"></script><script>varVirtualList=window.VirtualList;...</script>

importReactfrom'react';import{render}from'react-dom';importVirtualListfrom'react-tiny-virtual-list';constdata=['A','B','C','D','E','F', ...];render(<VirtualListwidth='100%'height={600}itemCount={data.length}itemSize={50}// Also supports variable heights (array or function getter)renderItem={({index, style})=><divkey={index}style={style}> // The style property contains the item's absolute position        Letter:{data[index]}, Row: #{index}</div>}/>,document.getElementById('root'));

* Width may only be a string whenscrollDirection is'vertical'. Similarly, Height may only be a string ifscrollDirection is'horizontal'

This method force recomputes the item sizes after the specified index (these are normally cached).

VirtualList has no way of knowing when its underlying data has changed, since it only receives a itemSize property. If the itemSize is anumber, this isn't an issue, as it can compare before and after values and automatically callrecomputeSizes internally.However, if you're passing a function toitemSize, that type of comparison is error prone. In that event, you'll need to callrecomputeSizes manually to inform theVirtualList that the size of its items has changed.

react-tiny-virtual-list usesPureComponent, so it only updates when it's props change. Therefore, if only the order of your data changes (eg['a','b','c'] =>['d','e','f']),react-tiny-virtual-list has no way to know your data has changed and that it needs to re-render.

You can force it to re-render by callingforceUpdate on it or by passing it an extra prop that will change every time your data changes.

Found an issue? Pleasereport it along with any relevant details to reproduce it. If you can, please provide a live demo replicating the issue you're describing. You canfork this Code Sandbox as a starting point.

Feature requests / pull requests are welcome, though please take a moment to make sure your contributions fits within the scope of the project.Learn how to contribute

This library draws inspiration fromreact-virtualized, and is meant as a bare-minimum replacement for theList component. If you're looking for a tiny, lightweight and dependency-free list virtualization library that supports variable heights, you're in the right place! If you're looking for something that supports more use-cases, I highly encourage you to check outreact-virtualized instead, it's a fantastic library ❤️

react-tiny-virtual-list is available under the MIT License.