Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork815
React components for efficiently rendering large lists and tabular data
License
bvaughn/react-window
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
react-window is a component library that helps render large lists of data quickly and without the performance problems that often go along with rendering a lot of data. It's used in a lot of places, from React DevTools to the Replay browser.
If you like this project there are several ways to support it:
The following wonderful companies and individuals have sponsored react-window:
Begin by installing the library from NPM:
npm install react-window
TypeScript definitions are included within the publisheddist folder
Documentation for this project is available atreact-window.vercel.app; version 1.x documentation can be found atreact-window-v1.vercel.app.
| Name | Description |
|---|---|
| rowComponent | React component responsible for rendering a row. This component will receive an ℹ️ The prop types for this component are exported as |
| rowCount | Number of items to be rendered in the list. |
| rowHeight | Row height; the following formats are supported:
|
| rowProps | Additional props to be passed to the row-rendering component.List will automatically re-render rows when values in this object change.
|
| Name | Description |
|---|---|
| className | CSS class name. |
| style | Optional CSS properties.The list of rows will fill the height defined by this style. |
| children | Additional content to be rendered within the list (above cells).This property can be used to render things like overlays or tooltips. |
| defaultHeight | Default height of list for initial render.This value is important for server rendering. |
| listRef | Ref used to interact with this component's imperative API. This API has imperative methods for scrolling and a getter for the outermost DOM element. ℹ️ The |
| onResize | Callback notified when the List's outermost HTMLElement resizes.This may be used to (re)scroll a row into view. |
| onRowsRendered | Callback notified when the range of visible rows changes. |
| overscanCount | How many additional rows to render outside of the visible area.This can reduce visual flickering near the edges of a list when scrolling. |
| tagName | Can be used to override the root HTML element rendered by the List component.The default value is "div", meaning that List renders an HTMLDivElement as its root. |
| Name | Description |
|---|---|
| cellComponent | React component responsible for rendering a cell. This component will receive an ℹ️ The prop types for this component are exported as |
| cellProps | Additional props to be passed to the cell-rendering component.Grid will automatically re-render cells when values in this object change.
|
| columnCount | Number of columns to be rendered in the grid. |
| columnWidth | Column width; the following formats are supported:
|
| rowCount | Number of rows to be rendered in the grid. |
| rowHeight | Row height; the following formats are supported:
|
| Name | Description |
|---|---|
| className | CSS class name. |
| dir | Corresponds to the HTML dir attribute:https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/dir |
| style | Optional CSS properties.The grid of cells will fill the height and width defined by this style. |
| children | Additional content to be rendered within the grid (above cells).This property can be used to render things like overlays or tooltips. |
| defaultHeight | Default height of grid for initial render.This value is important for server rendering. |
| defaultWidth | Default width of grid for initial render.This value is important for server rendering. |
| gridRef | Ref used to interact with this component's imperative API. This API has imperative methods for scrolling and a getter for the outermost DOM element. ℹ️ The |
| onCellsRendered | Callback notified when the range of rendered cells changes. |
| onResize | Callback notified when the Grid's outermost HTMLElement resizes.This may be used to (re)scroll a cell into view. |
| overscanCount | How many additional rows/columns to render outside of the visible area.This can reduce visual flickering near the edges of a grid when scrolling. |
| tagName | Can be used to override the root HTML element rendered by the List component.The default value is "div", meaning that List renders an HTMLDivElement as its root. |
About
React components for efficiently rendering large lists and tabular data
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.