67 lines
4.5 KiB
Markdown
67 lines
4.5 KiB
Markdown
|
# rc-virtual-list
|
||
|
|
|
||
|
|
React Virtual List Component which worked with animation.
|
||
|
|
|
||
|
|
[![NPM version][npm-image]][npm-url] [](https://github.com/umijs/dumi) [![build status][github-actions-image]][github-actions-url] [![Test coverage][coveralls-image]][coveralls-url] [![node version][node-image]][node-url] [![npm download][download-image]][download-url]
|
||
|
|
|
||
|
|
[npm-image]: http://img.shields.io/npm/v/rc-virtual-list.svg?style=flat-square
|
||
|
|
[npm-url]: http://npmjs.org/package/rc-virtual-list
|
||
|
|
[github-actions-image]: https://github.com/react-component/virtual-list/workflows/CI/badge.svg
|
||
|
|
[github-actions-url]: https://github.com/react-component/virtual-list/actions
|
||
|
|
[coveralls-image]: https://img.shields.io/codecov/c/github/react-component/virtual-list/master.svg?style=flat-square
|
||
|
|
[coveralls-url]: https://codecov.io/gh/react-component/virtual-list
|
||
|
|
[node-image]: https://img.shields.io/badge/node.js-%3E=_6.0-green.svg?style=flat-square
|
||
|
|
[node-url]: http://nodejs.org/download/
|
||
|
|
[download-image]: https://img.shields.io/npm/dm/rc-virtual-list.svg?style=flat-square
|
||
|
|
[download-url]: https://npmjs.org/package/rc-virtual-list
|
||
|
|
|
||
|
|
## Online Preview
|
||
|
|
|
||
|
|
https://virtual-list-react-component.vercel.app/
|
||
|
|
|
||
|
|
## Development
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install
|
||
|
|
npm start
|
||
|
|
open http://localhost:9001/
|
||
|
|
```
|
||
|
|
|
||
|
|
## Feature
|
||
|
|
|
||
|
|
- Support react.js
|
||
|
|
- Support animation
|
||
|
|
- Support IE11+
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
[](https://npmjs.org/package/rc-virtual-list)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
import List from 'rc-virtual-list';
|
||
|
|
|
||
|
|
<List data={[0, 1, 2]} height={200} itemHeight={30} itemKey="id">
|
||
|
|
{index => <div>{index}</div>}
|
||
|
|
</List>;
|
||
|
|
```
|
||
|
|
|
||
|
|
# API
|
||
|
|
|
||
|
|
## List
|
||
|
|
|
||
|
|
| Prop | Description | Type | Default |
|
||
|
|
| ---------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
||
|
|
| children | Render props of item | (item, index, props) => ReactElement | - |
|
||
|
|
| component | Customize List dom element | string \| Component | div |
|
||
|
|
| data | Data list | Array | - |
|
||
|
|
| disabled | Disable scroll check. Usually used on animation control | boolean | false |
|
||
|
|
| height | List height | number | - |
|
||
|
|
| itemHeight | Item minium height | number | - |
|
||
|
|
| itemKey | Match key with item | string | - |
|
||
|
|
| styles | style | { horizontalScrollBar?: React.CSSProperties; horizontalScrollBarThumb?: React.CSSProperties; verticalScrollBar?: React.CSSProperties; verticalScrollBarThumb?: React.CSSProperties; } | - |
|
||
|
|
|
||
|
|
`children` provides additional `props` argument to support IE 11 scroll shaking.
|
||
|
|
It will set `style` to `visibility: hidden` when measuring. You can ignore this if no requirement on IE.
|