1.0.12 • Published 6 years ago

react-infinite-scroll-container v1.0.12

Weekly downloads
315
License
MIT
Repository
github
Last release
6 years ago

React Infinite Scroller

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

How to use

import InfiniteScroll from 'react-infinite-scroller';

Window scroll events

<InfiniteScroll
    pageStart={0}
    loadMore={loadFunc}
    hasMore={true || false}
    loader={<div className="loader">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">Loading ...</div>}
        useWindow={false}
    >
        {items}
    </InfiniteScroll>
</div>

Props

NameTypeDefaultDescription
elementString'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.
loadMoreFunctionA callback when more items are requested by the user.
pageStartObject0The number of the first page to load, With the default of 0, the first page is 1.
thresholdBoolean250The distance in pixels before the end of the items that will trigger a call to loadMore.
useWindowBooleantrueAdd scroll listeners to the window, or else, the component's parentNode.
1.0.12

6 years ago

1.0.11

6 years ago

1.0.10

6 years ago

1.0.9

7 years ago

1.0.8

8 years ago

1.0.7

8 years ago

1.0.6

8 years ago

1.0.5

8 years ago

1.0.4

8 years ago

1.0.3

8 years ago

1.0.2

8 years ago