Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danbovey/react-infinite-scroller
⏬ Infinite scroll component for React in ES6
https://github.com/danbovey/react-infinite-scroller
infinite-scroll react react-component
Last synced: 2 months ago
JSON representation
⏬ Infinite scroll component for React in ES6
- Host: GitHub
- URL: https://github.com/danbovey/react-infinite-scroller
- Owner: danbovey
- License: mit
- Fork: true (guillaumervls/react-infinite-scroll)
- Created: 2016-03-07T22:00:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T11:48:23.000Z (4 months ago)
- Last Synced: 2024-04-24T16:06:13.563Z (2 months ago)
- Topics: infinite-scroll, react, react-component
- Language: JavaScript
- Homepage: https://danbovey.uk/react-infinite-scroller/
- Size: 1.87 MB
- Stars: 3,250
- Watchers: 21
- Forks: 508
- Open Issues: 98
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - react-infinite-scroller
- awesome-stars - react-infinite-scroller
- awesome-stars - react-infinite-scroller
- awesome - danbovey/react-infinite-scroller - ⏬ Infinite scroll component for React in ES6 (JavaScript)
- awesome-stars - danbovey/react-infinite-scroller - ⏬ Infinite scroll component for React in ES6 (JavaScript)
- my-awesome-stars - danbovey/react-infinite-scroller - ⏬ Infinite scroll component for React in ES6 (JavaScript)
- awesome-stars - danbovey/react-infinite-scroller - ⏬ Infinite scroll component for React in ES6 (JavaScript)
README
# React Infinite Scroller
[](https://www.npmjs.com/package/react-infinite-scroller)
[](https://www.npmjs.com/package/react-infinite-scroller)
[](https://github.com/danbovey/react-infinite-scroller/blob/master/LICENSE)
Infinitely load a grid or list of items in React. This component allows you to create a simple, lightweight infinite scrolling page or element by supporting both window and scrollable elements.
- ⏬ Ability to use window or a scrollable element
- 📏 No need to specify item heights
- 💬 Support for "chat history" (reverse) mode
- ✅ Fully unit tested and used in hundreds of production sites around the
world!
- 📦 Lightweight alternative to other available React scroll libs ~ 2.2KB
minified & gzipped
---
- [Demo](https://danbovey.uk/react-infinite-scroller/demo/)
- [Demo Source](https://github.com/danbovey/react-infinite-scroller/blob/master/docs/src/index.js)
## Installation
```
npm install react-infinite-scroller --save
```
```
yarn add react-infinite-scroller
```
## How to use
```js
import InfiniteScroll from 'react-infinite-scroller';
```
### Window scroll events
```js
Loading ...}
>
{items} // <-- This is the content you want to load
```
### DOM scroll events
```js
Loading ...}
useWindow={false}
>
{items}
```
### Custom parent element
You can define a custom `parentNode` element to base the scroll calulations on.
```js
this.scrollParentRef = ref}>
Loading ...}
useWindow={false}
getScrollParent={() => this.scrollParentRef}
>
{items}
```
## Props
| Name | Required | Type | Default | Description |
| :---------------- | :------- | :----------- | :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `children` | Yes | `Node` | | Anything that can be rendered (same as PropType's Node) |
| `loadMore` | Yes | `Function` | | A callback when more items are requested by the user. Receives a single parameter specifying the page to load e.g. `function handleLoadMore(page) { /* load more items here */ }` } |
| `element` | | `Component` | `'div'` | Name of the element that the component should render as. |
| `hasMore` | | `Boolean` | `false` | Whether there are more items to be loaded. Event listeners are removed if `false`. |
| `initialLoad` | | `Boolean` | `true` | Whether the component should load the first set of items. |
| `isReverse` | | `Boolean` | `false` | Whether new items should be loaded when user scrolls to the top of the scrollable area. |
| `loader` | | `Component` | | A React component to render while more items are loading. The parent component must have a unique key prop. |
| `pageStart` | | `Number` | `0` | The number of the first page to load, With the default of `0`, the first page is `1`. |
| `getScrollParent` | | `Function` | | Override method to return a different scroll listener if it's not the immediate parent of InfiniteScroll. |
| `threshold` | | `Number` | `250` | The distance in pixels before the end of the items that will trigger a call to `loadMore`. |
| `useCapture` | | `Boolean` | `false` | Proxy to the `useCapture` option of the added event listeners. |
| `useWindow` | | `Boolean` | `true` | Add scroll listeners to the window, or else, the component's `parentNode`. |
## Troubleshooting
### Double or non-stop calls to `loadMore`
If you experience double or non-stop calls to your `loadMore` callback, make
sure you have your CSS layout working properly before adding this component in.
Calculations are made based on the height of the container (the element the
component creates to wrap the items), so the height of the container must equal
the entire height of the items.
```css
.my-container {
overflow: auto;
}
```
Some people have found success using [react-infinite-scroll-component](https://github.com/ankeetmaini/react-infinite-scroll-component).
### But you should just add an `isLoading` prop!
This component doesn't make any assumptions about what you do in terms of API
calls. It's up to you to store whether you are currently loading items from an
API in your state/reducers so that you don't make overlapping API calls.
```js
loadMore() {
if(!this.state.isLoading) {
this.props.fetchItems();
}
}
```