1.1.6 • Published 6 years ago

react-infinite-scroller-modified v1.1.6

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

React Infinite Scroller-MODIFIED

This is fork of React-Infinite-Scroller

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-modified --save
yarn add react-infinite-scroller-modified

How to use

import InfiniteScroll from 'react-infinite-scroller-modified';

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>

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.
isReverseBooleanfalseWhether new items should be loaded when user scrolls to the top of the scrollable area.
loadMore      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 */ } }
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.
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.