Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ankeetmaini/react-infinite-scroll-component

An awesome Infinite Scroll component in react.
https://github.com/ankeetmaini/react-infinite-scroll-component

component infinite-lists infinite-scroll npm-package react

Last synced: 26 days ago
JSON representation

An awesome Infinite Scroll component in react.

Host: GitHub
URL: https://github.com/ankeetmaini/react-infinite-scroll-component
Owner: ankeetmaini
License: mit
Created: 2016-03-17T13:28:29.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2023-10-18T13:17:11.000Z (about 1 year ago)
Last Synced: 2024-10-13T03:03:25.599Z (26 days ago)
Topics: component, infinite-lists, infinite-scroll, npm-package, react
Language: TypeScript
Homepage: https://react-infinite-scroll-component.netlify.com/
Size: 2.5 MB
Stars: 2,866
Watchers: 20
Forks: 320
Open Issues: 193
Metadata Files:
- Readme: README.md
- License: license

Awesome Lists containing this project

awesome-web-cn - react-infinite-scroll-component - 一个基于 React 的无限滚动组件 (Uncategorized / Uncategorized)

README

# react-infinite-scroll-component [![npm](https://img.shields.io/npm/dt/react-infinite-scroll-component.svg?style=flat-square)](https://www.npmjs.com/package/react-infinite-scroll-component) [![npm](https://img.shields.io/npm/v/react-infinite-scroll-component.svg?style=flat-square)](https://www.npmjs.com/package/react-infinite-scroll-component)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

A component to make all your infinite scrolling woes go away with just 4.15 kB! `Pull Down to Refresh` feature
added. An infinite-scroll that actually works and super-simple to integrate!

## Install

```bash
npm install --save react-infinite-scroll-component

yarn add react-infinite-scroll-component

// in code ES6
import InfiniteScroll from 'react-infinite-scroll-component';
// or commonjs
var InfiniteScroll = require('react-infinite-scroll-component');
```

## Using

```jsx
Loading...}
endMessage={

Yay! You have seen it all

}
// below props only if you need pull down functionality
refreshFunction={this.refresh}
pullDownToRefresh
pullDownToRefreshThreshold={50}
pullDownToRefreshContent={

↓ Pull down to refresh

}
releaseToRefreshContent={

↑ Release to refresh

}
>
{items}

```

## Using scroll on top

```jsx

{/*Put the scroll bar always on the bottom*/}
Loading...}
scrollableTarget="scrollableDiv"
>
{this.state.items.map((_, index) => (

div - #{index}

))}

```

The `InfiniteScroll` component can be used in three ways.

- Specify a value for the `height` prop if you want your **scrollable** content to have a specific height, providing scrollbars for scrolling your content and fetching more data.
- If your **scrollable** content is being rendered within a parent element that is already providing overflow scrollbars, you can set the `scrollableTarget` prop to reference the DOM element and use it's scrollbars for fetching more data.
- Without setting either the `height` or `scrollableTarget` props, the scroll will happen at `document.body` like _Facebook's_ timeline scroll.

## docs version wise

[3.0.2](docs/README-3.0.2.md)

## live examples

- infinite scroll (never ending) example using react (body/window scroll)
- [![Edit yk7637p62z](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/yk7637p62z)
- infinte scroll till 500 elements (body/window scroll)
- [![Edit 439v8rmqm0](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/439v8rmqm0)
- infinite scroll in an element (div of height 400px)
- [![Edit w3w89k7x8](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/w3w89k7x8)
- infinite scroll with `scrollableTarget` (a parent element which is scrollable)
- [![Edit r7rp40n0zm](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/r7rp40n0zm)

## props

| name
| ---------------
| **next**
| **hasMore**
| **children**
| **dataLength**
| **loader**
| **scrollThreshold**
| **onScroll**
| **endMessage**
| **className**
| **style**
| **height**
| **scrollableTarget**
| **hasChildren**
| **pullDownToRefresh**
| **pullDownToRefreshContent**
| **releaseToRefreshContent**
| **pullDownToRef
| **refreshFunction**
| **initialScrollY**
| **inverse** | type | description | --------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | function | a function which must be called after reaching the bottom. It must trigger some sort of action which fetches the next data. **The data is passed as `children` to the `InfiniteScroll` component and the data should contain previous items too.** e.g. _Initial data = [1, 2, 3]_ and then next load of data should be _[1, 2, 3, 4, 5, 6]_. | | boolean | it tells the `InfiniteScroll` component on whether to call `next` function on reaching the bottom and shows an `endMessage` to the user | | node (list) | the data items which you need to scroll. | | number | set the length of the data.This will unlock the subsequent calls to next. | | node | you can send a loader component to show while the component waits for the next load of data. e.g. `

Loading...

` or any fancy loader element | | number | string | A threshold value defining when `InfiniteScroll` will call `next`. Default value is `0.8`. It means the `next` will be called when user comes below 80% of the total height. If you pass threshold in pixels (`scrollThreshold="200px"`), `next` will be called once you scroll at least (100% - scrollThreshold) pixels down. | | function | a function that will listen to the scroll event on the scrolling container. Note that the scroll event is throttled, so you may not receive as many events as you would expect. | | node | this message is shown to the user when he has seen all the records which means he's at the bottom and `hasMore` is `false` | | string | add any custom class you want | | object | any style which you want to override | | number | optional, give only if you want to have a fixed height scrolling content | | node or string | optional, reference to a (parent) DOM element that is already providing overflow scrollbars to the `InfiniteScroll` component. _You should provide the `id` of the DOM node preferably._ | | bool | `children` is by default assumed to be of type array and it's length is used to determine if loader needs to be shown or not, if your `children` is not an array, specify this prop to tell if your items are 0 or more. | | bool | to enable **Pull Down to Refresh** feature | | node | any JSX that you want to show the user, `default={

Pull down to refresh

}` | | node | any JSX that you want to show the user, `default={

Release to refresh

}` | reshThreshold** | number | minimum distance the user needs to pull down to trigger the refresh, `default=100px` , a lower value may be needed to trigger the refresh depending your users browser. | | function | this function will be called, it should return the fresh data that you want to show the user | | number | set a scroll y position for the component to render with. | | bool | set infinite scroll on top |

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Ankeet Maini}
💬 📖 💻 👀 🚧

_{Darsh Shah}
🚇

This project follows the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!

## LICENSE

[MIT](LICENSE)