JavaScript CSS HTML
Latest commit eab760f Nov 9, 2017 @TrySound TrySound Merge pull request #869 from dan-f/cellmeasurer-example-typos
Fix typos in CellMeasurer example modules
Permalink
Failed to load latest commit information.
.circleci Fixed CircleCI test step maybe Oct 15, 2017
codemods Added first codemod (for renamed components) Sep 14, 2016
docs Version 9.12.0 - Added defaultHeight and defaultWidth properties to A… Oct 21, 2017
playground Ran Prettier over playground files Oct 15, 2017
source Fix typos in CellMeasurer example modules Nov 9, 2017
.babelrc Remove babel-plugin-typecheck to fix flow bindings error Jul 23, 2017
.eslintignore Added lint ignore files Oct 15, 2017
.eslintrc Copied Flow+Lint+Prettier config from reactjs.org repo; pre-commit ho… Oct 15, 2017
.flowconfig Copied Flow+Lint+Prettier config from reactjs.org repo; pre-commit ho… Oct 15, 2017
.gitignore Add .vscode to .gitignore Jul 7, 2017
.nvmrc Updated to Node v6.6 to avoid Npm bug Sep 23, 2016
.prettierrc Copied Flow+Lint+Prettier config from reactjs.org repo; pre-commit ho… Oct 15, 2017
CHANGELOG.md Version 9.12.0 - Added defaultHeight and defaultWidth properties to A… Oct 21, 2017
CONTRIBUTING.md Project uses Slack over Gitter now Oct 20, 2017
ISSUE_TEMPLATE.md Added CodeSandbox to new issue template Oct 21, 2017
LICENSE Fix LICENSE Dec 4, 2015
PULL_REQUEST_TEMPLATE.md Fix typo in pull request template May 26, 2016
README.md Download badges link to npmcharts.com Sep 18, 2017
index.html Demo site structure tweaks Sep 18, 2016
package.json Version 9.12.0 - Added defaultHeight and defaultWidth properties to A… Oct 21, 2017
postcss.config.js Fixed lint error in PostCSS config; removed unused import in Webpack … Feb 16, 2017
webpack.config.demo.js Fixed lint error in PostCSS config; removed unused import in Webpack … Feb 16, 2017
webpack.config.dev.js Fixed lint error in PostCSS config; removed unused import in Webpack … Feb 16, 2017
webpack.config.umd.js Merged changes from master Feb 16, 2017
yarn.lock Copied Flow+Lint+Prettier config from reactjs.org repo; pre-commit ho… Oct 15, 2017

README.md

React virtualized

NPM version NPM license NPM total downloads NPM monthly downloads Circle CI badge Codecov badge Slack chat OpenCollective OpenCollective

React components for efficiently rendering large lists and tabular data. Check out the demo for some examples. Join the official Slack chat at react-virtualized.now.sh.

Sponsors

The following wonderful companies have sponsored react-virtualized:

Learn more about becoming a sponsor!

Getting started

Install react-virtualized using npm.

npm install react-virtualized --save

ES6, CommonJS, and UMD builds are available with each distribution. 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'

// But if you only use a few react-virtualized components,
// And you're concerned about increasing your application's bundle size,
// You can directly import only the components you need, like so:
import AutoSizer from 'react-virtualized/dist/commonjs/AutoSizer'
import List from 'react-virtualized/dist/commonjs/List'

You can also use a global-friendly UMD build:

<link rel="stylesheet" href="path-to-react-virtualized/styles.css">
<script src="path-to-react-virtualized/dist/umd/react-virtualized.js"></script>

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 use shallowCompare to avoid re-rendering unless props or state has changed. This ocassionally 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

The shallowCompare method will detect changes to any props, even if they aren't declared as propTypes. 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 and Collection components can be forcefully re-rendered using forceUpdate. For Table and List, you'll need to call forceUpdateGrid to ensure that the inner Grid is also updated.

Documentation

API documentation available here.

There are also a couple of how-to guides:

Examples

Examples for each component can be seen in the documentation.

Here are some online demos of each component:

And here are some "recipe" type demos:

Supported Browsers

react-virtualized aims to support all evergreen browsers and recent mobile browsers for iOS and Android. IE 9+ is also supported (although IE 9 will require some user-defined, custom CSS since flexbox layout is not supported).

If you find a browser-specific problem, please report it along with a repro case. The easiest way to do this is probably by forking this Plunker.

Friends

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

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.