react-infinite-scroll-component
v6.1.1TypeScript
An Infinite Scroll component in react.
0/weekUpdated 2 months agoMITUnpacked: 168.7 KB
Published by Ankeet Maini
npm install react-infinite-scroll-componentreact-infinite-scroll-component  
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
or
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`
next={fetchData}
hasMore={true}
loader={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
style={{
height: 300,
overflow: 'auto',
display: 'flex',
flexDirection: 'column-reverse',
}}
>
{/Put the scroll bar always on the bottom/}
next={this.fetchMoreData}
style={{ display: 'flex', flexDirection: 'column-reverse' }} //To put endMessage and loader to the top.
inverse={true} //
hasMore={true}
loader={Loading...
}
scrollableTarget="scrollableDiv"
>
{this.state.items.map((_, index) => (
div - #{index}
))}
`
The
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
live examples
- infinite scroll (never ending) example using react (body/window scroll)
- 
- infinte scroll till 500 elements (body/window scroll)
- 
- infinite scroll in an element (div of height 400px)
- 
- infinite scroll with
scrollableTarget (a parent element which is scrollable)
- props
| name | type | description |
| ------------------------------ | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| next | 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]_. |
| hasMore | boolean | it tells the InfiniteScroll component on whether to call next function on reaching the bottom and shows an endMessage to the user |
| children | node (list) | the data items which you need to scroll. |
| dataLength | number | set the length of the data.This will unlock the subsequent calls to next. |
| loader | 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 |
| scrollThreshold | 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. |
| onScroll | 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. |
| endMessage | 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 |
| className | string | add any custom class you want |
| style | object | any style which you want to override |
| height | number | optional, give only if you want to have a fixed height scrolling content |
| scrollableTarget | 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._ |
| hasChildren | 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. |
| pullDownToRefresh | bool | to enable Pull Down to Refresh feature |
| pullDownToRefreshContent | node | any JSX that you want to show the user, default={Pull down to refresh
} |
| releaseToRefreshContent | node | any JSX that you want to show the user, default={Release to refresh
} |
| pullDownToRefreshThreshold | 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. || refreshFunction | function | this function will be called, it should return the fresh data that you want to show the user |
| initialScrollY | number | set a scroll y position for the component to render with. |
| inverse | bool | set infinite scroll on top |
Contributors ✨
Thanks goes to these wonderful people (emoji key):
 Ankeet Maini 💬 📖 💻 👀 🚧 |  Darsh Shah 🚇 |
This project follows the all-contributors specification. Contributions of any kind are welcome!