react-infinite-scroller

⏬ Infinite scroll component for React in ES6

Showing:

Popularity

Downloads/wk

271K

GitHub Stars

2.3K

Maintenance

Last Commit

2yrs ago

Contributors

37

Package

Dependencies

1

Size (min+gzip)

2.3KB

License

MIT

Type Definitions

Tree-Shakeable

Yes?

Readme

React Infinite Scroller

Travis npm React Version npm npm

Infinitely load content using a React Component. This fork maintains a simple, lightweight infinite scroll package that supports both window and scrollable elements.

Installation

npm install react-infinite-scroller --save
yarn add react-infinite-scroller

How to use

import InfiniteScroll from 'react-infinite-scroller';

Window scroll events

<InfiniteScroll
    pageStart={0}
    loadMore={loadFunc}
    hasMore={true || false}
    loader={<div className="loader" key={0}>Loading ...</div>}
>
    {items} // <-- This is the content you want to load
</InfiniteScroll>

DOM scroll events

<div style="height:700px;overflow:auto;">
    <InfiniteScroll
        pageStart={0}
        loadMore={loadFunc}
        hasMore={true || false}
        loader={<div className="loader" key={0}>Loading ...</div>}
        useWindow={false}
    >
        {items}
    </InfiniteScroll>
</div>

Custom parent element

You can define a custom parentNode element to base the scroll calulations on.

<div style="height:700px;overflow:auto;" ref={(ref) => this.scrollParentRef = ref}>
    <div>
        <InfiniteScroll
            pageStart={0}
            loadMore={loadFunc}
            hasMore={true || false}
            loader={<div className="loader" key={0}>Loading ...</div>}
            useWindow={false}
            getScrollParent={() => this.scrollParentRef}
        >
            {items}
        </InfiniteScroll>
    </div>
</div>

Props

NameRequiredTypeDefaultDescription
children      YesNode           Anything that can be rendered (same as PropType's Node)
loadMore      YesFunction           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 */ } }
elementComponent'div'Name of the element that the component should render as.
hasMoreBooleanfalseWhether there are more items to be loaded. Event listeners are removed if false.
initialLoadBooleantrueWhether the component should load the first set of items.
isReverseBooleanfalseWhether new items should be loaded when user scrolls to the top of the scrollable area.
loaderComponentA React component to render while more items are loading. The parent component must have a unique key prop.
pageStartNumber0The number of the first page to load, With the default of 0, the first page is 1.
getScrollParentFunctionOverride method to return a different scroll listener if it's not the immediate parent of InfiniteScroll.
thresholdNumber250The distance in pixels before the end of the items that will trigger a call to loadMore.
useCaptureBooleanfalseProxy to the useCapture option of the added event listeners.
useWindowBooleantrueAdd scroll listeners to the window, or else, the component's parentNode.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Tutorials

No tutorials found
Add a tutorial