Infinite loader utils inspired by `react-virtualized` but for use with `react-window`.
npm install react-window-infinite-loaderInfinite loader utils inspired by react-virtualized but for use with react-window.
If you like this project, 🎉 become a sponsor or ☕ buy me a coffee.
Begin by installing the library from NPM:
``sh`
npm install react-window-infinite-loader
The recommended way to use this library is the new useInfiniteLoader hook:`tsx
import { useInfiniteLoader } from "react-window-infinite-loader";
function Example() {
const onRowsRendered = useInfiniteLoader(props);
return ;
}
`
The InfiniteLoader component also exists, though it has changed since version 1:onItemsRendered
- Child function parameter renamed to onRowsRenderedlistRef
- Child function parameter removed
`tsx
import { InfiniteLoader } from "react-window-infinite-loader";
function Example() {
return (
{({ onRowsRendered }) => }
);
}
`
| ({ onRowsRendered: Function }) => ReactNode | Render prop; see below for example usage. |
| isRowLoaded | (index: number) => boolean | Function responsible for tracking the loaded state of each row. |
| loadMoreRows | (startIndex: number, stopIndex: number) => Promise | Callback to be invoked when more rows must be loaded. It should return a Promise that is resolved once all data has finished loading. |
| rowCount | number | Number of rows in list; can be arbitrary high number if actual number is unknown. |$3
| Name | Type | Description |
| --- | --- | --- |
| minimumBatchSize | number | Minimum number of rows to be loaded at a time; defaults to 10. This property can be used to batch requests to reduce HTTP requests. |
| threshold | number` | Threshold at which to pre-fetch data; defaults to 15. A threshold of 15 means that data will start loading when a user scrolls within 15 rows. |