react-infinite-scroll-fixed

1.0.17 • Public • Published

React Infinite Scroll Fixed

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-scroll-fixed --save
yarn add react-infinite-scroll-fixed

How to use

import InfiniteScroll from 'react-infinite-scroll-fixed';

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

Name Type Default Description
element String 'div' Name of the element that the component should render as.
hasMore Boolean false Whether there are more items to be loaded. Event listeners are removed if false.
initialLoad Boolean true Whether the component should load the first set of items.
isReverse Boolean false Whether 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 */ } }
loader Component A React component to render while more items are loading.
pageStart Number 0 The number of the first page to load, With the default of 0, the first page is 1.
threshold Number 250 The distance in pixels before the end of the items that will trigger a call to loadMore.
useCapture Boolean false Proxy to the useCapture option of the added event listeners.
useWindow Boolean true Add scroll listeners to the window, if not, to the component's parentNode or scrollParent.
scrollParent Element null Add scroll listeners to the some other parent element other than immediate parent node when useWindow is set to false.

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
1.0.17103latest

Version History

VersionDownloads (Last 7 Days)Published
1.0.17103
1.0.160
0.1.80
0.1.70
0.1.60

Package Sidebar

Install

npm i react-infinite-scroll-fixed

Weekly Downloads

103

Version

1.0.17

License

MIT

Last publish

Collaborators

  • ganapativs