bvaughn/react-virtualized

React components for efficiently rendering large lists and tabular data. Check out the documentation for live examples.

If you like this project, 🎉 become a sponsor or ☕ buy me a coffee

Sponsors

The following wonderful companies have sponsored react-virtualized:

Learn more about becoming a sponsor!

A word about react-window

If you're considering adding react-virtualized to a project, take a look at react-window as a possible lighter-weight alternative.

Getting started

Install react-virtualized using npm.

npm install react-virtualized --save

ES module and CommonJS builds are included, along with TypeScript type definitions. For example:

// Most of react-virtualized's styles are functional (eg position, size).
// Functional styles are applied directly to DOM elements.
// The Table component ships with a few presentational styles as well.
// They are optional, but if you want them you will need to also import the CSS file.
// This only needs to be done once; probably during your application's bootstrapping process.
import 'react-virtualized/styles.css';

// You can import any component you want as a named export from 'react-virtualized', eg
import {Column, Table} from 'react-virtualized';

The package is marked as side-effect free (other than its CSS), so bundlers will tree-shake any components you don't use.

TypeScript types are exported for each component's props (e.g. ListProps, GridProps, TableProps) along with the parameters passed to renderers (e.g. RowRendererParams, CellRendererParams, TableCellProps).

Now you're ready to start using the components. You can learn more about which components react-virtualized has to offer below.

Dependencies

React Virtualized has very few dependencies and most are managed by NPM automatically. However the following peer dependencies must be specified by your project in order to avoid version conflicts: react, react-dom. NPM will not automatically install these for you but it will show you a warning message with instructions on how to install them.

Pure Components

By default all react-virtualized components are wrapped in memo to avoid re-rendering unless props or state has changed. This occasionally confuses users when a collection's data changes (eg ['a','b','c'] => ['d','e','f']) but props do not (eg array.length).

The solution to this is to let react-virtualized know that something external has changed. This can be done a couple of different ways.

Pass-thru props

This shallow comparison will detect changes to any props, even ones a component doesn't use. This means you can also pass through additional properties that affect cell rendering to ensure changes are detected. For example, if you're using List to render a list of items that may be re-sorted after initial render- react-virtualized would not normally detect the sort operation because none of the properties it deals with change. However you can pass through the additional sort property to trigger a re-render. For example:

<List {...listProps} sortBy={sortBy} />

Public methods

Grid components can be forcefully re-rendered by calling forceUpdate on their ref. For Table and List, you'll need to call forceUpdateGrid to ensure that the inner Grid is also updated. For MultiGrid, you'll need to call forceUpdateGrids to ensure that the inner Grids are updated.

Documentation

Documentation and live examples for every component are available at react-virtualized-docs.vercel.app.

Components:

• Grid
• List
• Masonry
• MultiGrid (a Grid with fixed rows and columns)
• Table

CellMeasurer measures cells whose sizes aren't known ahead of time.

Grid, List, Masonry and Table can also be scrolled by the window (or another scrollable element) with the scrollElement prop.

Higher-order components:

• ArrowKeyStepper
• ColumnSizer
• InfiniteLoader
• ScrollSync

[!NOTE] AutoSizer is no longer part of react-virtualized (as of version 10); it is available as the separate react-virtualized-auto-sizer package. See sizing components for how to use it with react-virtualized.

There are also a couple of how-to guides:

• Customizing classes and styles
• Displaying items in reverse order
• Sizing components
• Server rendering
• Creating an infinite-loading list
• Natural sort Table
• Sorting a Table by multiple columns

Examples

Here are some "recipe" type demos:

• Table with resizable (drag and drop) columns
• Dynamic cell measuring
• Fixed header and column (spreadsheet)

Supported Browsers

react-virtualized aims to support all evergreen browsers and recent mobile browsers for iOS and Android.

If you find a browser-specific problem, please report it along with a repro case (e.g. a CodeSandbox).

Friends

Here are some great components built on top of react-virtualized:

• react-infinite-calendar: Infinite scrolling date-picker with localization, themes, keyboard support, and more
• react-sortable-hoc: Higher-order components to turn any list into an animated, touch-friendly, sortable list
• react-sortable-tree: Drag-and-drop sortable representation of hierarchical data
• react-virtualized-checkbox: Checkbox group component with virtualization for large number of options
• react-virtualized-select: Drop-down menu for React with windowing to support large numbers of options.
• react-virtualized-tree: A reactive tree component that aims to render large sets of tree structured data in an elegant and performant way
• react-timeline-9000: A calendar timeline component that is capable of displaying and interacting with a large number of items

Contributions

Use GitHub issues for requests.

I actively welcome pull requests; learn how to contribute.

Changelog

Changes are tracked in the changelog.

License

react-virtualized is available under the MIT License.