/react-virtualize

react virtualized render

Primary LanguageTypeScriptMIT LicenseMIT

react-virtualize

中文文档

react-virtualize is a virtual rendering library like react-window.

Feature

  1. react-virtualize is more lightweight, only 100 lines of code, 2 KB in size.
  2. react-virtualize has better performance, javascript execution time when scrolling is only 20% of react-window
  3. react-virtualize is written using hooks, full support for functional programming and typescript

Install

Note: not react-virtualized

# Yarn
yarn add react-virtualize

# NPM
npm install --save react-virtualize

Usage

Usage is similar to react-window, there are some differentia:

  1. react-virtualize only support virtualize list, not support virtualize table.
  2. react-virtualize use renderItem function to render list items.
  3. react-virtualize use reRenderCount to determine if list updates are needed.
  4. react-virtualize use preRenderPageCount to control the number of pre-rendered pages.

Example

import List from "react-virtualize";
<List
  height={400}
  width={600}
  itemCount={props.dataSource.length} // used to traverse a list, usually the length of the list, numbers
  itemSize={(index) => {
    // used to control the height of a list item, numbers or functions can be passed
    return 100;
  }}
  reRenderCount={1} // re-render count, if your change list item‘s height, you must change this value
  preRenderPageCount={1} // pre-rendered pages count, the larger the number, the more list items will be pre-rendered
  renderItem={({ index, style }) => {
    // used to render list item, the style should be passed to item
    const data = props.dataSource[index];
    return <div style={style}>{data}</div>;
  }}
/>;

Interface

interface IProps {
  width: number;
  height: number;
  itemCount: number | (() => number);
  itemSize: number | ((index: number) => number);
  renderItem: (params: { index: number; style: CSSProperties }) => JSX.Element;
  reRenderCount?: number;
  preRenderPageCount?: number;
}

License

MIT