0.1.7 • Published 6 years ago
react-virtualized-listview v0.1.7
react-virtualized-listview
A simple virtualized listview inspired by react-virtualized
Getting started
The first step is to add react-virtualized-listview
into your project.
$ npm install --save react-virtualized-listview
Note: This library is not dependent on react-virtualized
which is a separate and highly customizable virtualized list library.
Usage
Import the package into your project using the import
statement
import List from 'react-virtualized-listview';
Example
const data = [1, 2, 3, 4, 5];
<List
source={data}
rowHeight={40}
renderItem={({ index, style }) => (
<div key={index} style={style}>
Hello {index}
</div>
)}
/>
API
renderItem
The renderItem function signature is as follows
({
index, // The index of each item in the source prop
style // The style that is applied to the row item
}) => <RowItem key={index} index={index} style={style}/>
Note: Passing the style
prop and applying in the root element of the row item is required
Features planned for next release
- Lists with dynamic height
- Expose internal components using default CSS classnames, custom classname injection and refs
- Add scroll persistence so that the scroll position persists between route changes
Contributing
To contribute, follow one of the two options:
Open an Issue
Open an issue detailing:
- What the issue is
- Steps to reproduce
- Possible solutions
Note: These details are recommended but are entirely optional.
Send a Pull Request
Fork this project and send a pull request to the
master
branch.
License
MIT