https://github.com/gnir-work/react-window-dynamic-list
A naive approach to virtualizing a dynamically sized list
https://github.com/gnir-work/react-window-dynamic-list
Last synced: 11 months ago
JSON representation
A naive approach to virtualizing a dynamically sized list
- Host: GitHub
- URL: https://github.com/gnir-work/react-window-dynamic-list
- Owner: gnir-work
- Created: 2020-04-01T16:18:27.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T22:45:32.000Z (almost 3 years ago)
- Last Synced: 2025-02-18T14:51:26.561Z (11 months ago)
- Language: JavaScript
- Size: 6.07 MB
- Stars: 49
- Watchers: 3
- Forks: 9
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - react-window-dynamic-list - work | 38 | (JavaScript)
README
# react-window-dynamic-list
> Made with the awesome [create-react-library](https://github.com/transitive-bullshit/create-react-library)
[](https://www.npmjs.com/package/react-window-dynamic-list) [](https://www.npmjs.com/package/react-window-dynamic-list) [](https://standardjs.com)
## How is this different from `react-window`?
This library comes to partly solve the case of rendering dynamically sized items with [react-window](https://github.com/bvaughn/react-window),
for more information about the issue please read [this thread](https://github.com/bvaughn/react-window/issues/6).
Before you overjoy please read the [limitations](#warning-requirements-and-limitations-warning) of this approach down bellow :sleepy:
## Demo
👉 [check out dynamic list in action](https://gnir-work.github.io/react-window-dynamic-list/)
:pencil2: [Play with the demo in sandbox](https://codesandbox.io/s/react-window-dynamic-list-example-iwvis?file=/src/App.js)
## Install
```bash
npm install --save react-window-dynamic-list
```
## Usage
Yep. its that simple :satisfied:
## API
The API is the same as [VariableSizeList](https://react-window.now.sh/#/api/VariableSizeList) with some small changes and additions.
#### Changes
1. Instead of `itemCount` you must pass `data` ([read more](#additions))
2. We handle `itemSize` and `estimatedItemSize` for you :sunglasses:
#### Additions
| Property | Type | Required? | Default | Description |
| :---------------------- | :------- | :-------: | :-----------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| data | `Object[]` | ✓ | | All of the data that will be displayed in the list.
Each `object` must contain an unique `id` field.
For example: `[{id: 1, ...}, {id: 2, ....}`] |
| cache | `Object` | ✓ | | The cache object which the list will use for caching the calculated sizes.
Check the [example](#usage) for how to create it. |
| lazyMeasurement | `boolean` | | `true` | Whether the application should fill the cache in the background.
Please note: After each cache clear the application will restart the lazy cache filling (For example after adding or removing an item)
For more information read the [caching section](#caching). |
| recalculateItemsOnResize | `Object` | | `{ width: false, height: false }` | Whether the list should recalculate the items size if its own size has changed. This value __should not__ change from its initial one.
Currently the feature is supported but far from perfect, therefore it is disabled by default. |
| measurementContainerElement | `Function` | | `({style, children}) => ReactNode` | A custom container element in which the elements will be rendered for measuring. Especially useful for changing the [scrollbar width](#warning-requirements-and-limitations-warning).
You **must** pass the `style` prop to your element. |
| debug | `boolean` | | `false` | Whether the measurement layer should be visible, useful for debugging a custom `measurementContainerElement` |
## Implementations details
### TL;DR:
Just in time measurement with caching in the background.
### Details:
The algorithm is divided into two main concepts:
#### Just in time measurements:
We measure each item in the list by temporary rendering it with `react-dom` in a different application.
For more information please read [this great article](https://medium.com/trabe/measuring-non-rendered-elements-in-react-with-portals-c5b7c51aec25).
#### Caching:
In order for just in time measurements to be effective we need to cache the measurements.
Currently there are two caching modes:
1. Cache only the items that were rendered
2. On top of caching the rendered items a background task will measure each element and fill the cache.
This is the **default behavior** as it gives a significant performance boost, especially in case of manipulating the data before scrolling through it.
In exchange there is a very mild slow down in overall performance in the first couple of seconds and after each change to the size of the list.
:warning: Please note: the lazy cache filling will be triggered in case you call `resetAfterIndex` function of `VariableSizeList`.
## :warning: Requirements and Limitations :warning:
1. Your data doesn't change its size.
- Your items size must be determined on mount (No `ajax` or images).
2. Currently only supports vertical layout. (didn't have time to implement support for horizontal).
3. All of the styling regarding the items **must** be `inline` or not affected by location in the `DOM`.
4. Changes to the list's scrollbar, especially the width, should also effect the measurement container div.
Since we pre render the items in order to measure them the size of the scrollbar is important in the pre rendered item as well. This can be achieved in the following ways:
1. Make sure all of the scrollbars in the application are styled the same
2. Pass a custom measurement container element via the `measurementContainerElement` prop.
## License
MIT © [gnir-work](https://github.com/gnir-work)