Skip to content
This repository was archived by the owner on Feb 27, 2024. It is now read-only.

Commit 8525bf6

Browse files
committed
docs: update README
1 parent 4524518 commit 8525bf6

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
# react-data-scroller
22

33
React component for scrolling large amounts of data efficiently
4+
5+
**This is currently a WIP and is not yet ready for production use. The API is
6+
not stable and is still evolving. Use at your own risk!**
7+
8+
![Screen Capture](/docs/assets/data-scroller-capture.gif)
9+
10+
## Why?
11+
react-data-scroller was originally designed as a drop in replacement for
12+
[react-virtualized](https://github.com/bvaughn/react-virtualized) but focused
13+
on preventing the constant mounting, unmounting and repainting of entire rows
14+
that occurs. The focus is rendering your data in the most efficient way
15+
which involves only rerendering (no unmounts/mounts and only minimal repainting)
16+
of the rows and shifting the data around.
17+
18+
**Feature Checklist**
19+
- [x] Column Groups
20+
- [ ] Scroll handling from parent
21+
- [ ] Horizontal Virtualization
22+
- [ ] Freezing any columns (Not just left)
23+
- [ ] Nested Groups

docs/assets/data-scroller-capture.gif

670 KB
Loading

0 commit comments

Comments
 (0)