# react-infi-scroller > React-based infinite scroll component Latest version **2.0.1** (published 2020-08-09) · MIT license · 0 weekly downloads ## Install ```sh npm install react-infi-scroller pnpm add react-infi-scroller yarn add react-infi-scroller bun add react-infi-scroller ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.1 | | Published | 2020-08-09 | | First published | 2020-04-16 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 22.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Neven Dyulgerov | | Maintainers | neven_dyulgerov | | Keywords | react, infinite-scroll, typescript | ## Links - npm: https://www.npmjs.com/package/react-infi-scroller - npm.io page: https://npm.io/package/react-infi-scroller ## Dependencies (1) - [get-node-dimensions](https://npm.io/package/get-node-dimensions.md) ^1.2.1 ## Alternatives - [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads - [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads - [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads - [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads - [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads ## Recent versions - 2.0.1 (latest) — 2020-08-09 - 2.0.0 — 2020-08-09 - 1.1.9 — 2020-08-09 - 1.1.8 — 2020-08-09 - 1.1.7 — 2020-08-09 - 1.1.6 — 2020-06-30 - 1.1.5 — 2020-05-01 - 1.1.4 — 2020-04-23 - 1.1.3 — 2020-04-20 - 1.1.2 — 2020-04-20 - 1.1.1 — 2020-04-17 - 1.1.0 — 2020-04-17 - 1.0.9 — 2020-04-17 - 1.0.8 — 2020-04-17 - 1.0.7 — 2020-04-17 - … 7 more at https://npm.io/package/react-infi-scroller/versions ## README # React Infi Scroller [![npm](https://img.shields.io/npm/v/react-infi-scroller.svg?style=flat-square)](https://www.npmjs.com/package/react-infi-scroller) [![npm](https://img.shields.io/npm/l/react-infi-scroller.svg?style=flat-square)](https://github.com/nevendyulgerov/react-infi-scroller/blob/master/LICENSE)

React-based infinite scroll component that just works. It supports window and scrollable nodes, without inline style for height.

## Installation To install the component, run: `npm install react-infi-scroller` ## How to use To import the component in your project: ```javascript import InfiScroller from 'react-infi-scroller'; ``` Use `InfiScroller` on the window object: ```javascript import React, { useState } from 'react'; import InfiScroller from 'react-infi-scroller'; const MyComponent = () => { const generateItems = (items = [], length = 30) => { const nextItems = [...items]; for (let i = 0; i < length; i += 1) { nextItems.push(items.length + i); } return nextItems; }; const [items, setItems] = useState(generateItems()); const [hasMore, setHasMore] = useState(true); return ( { const nextItems = generateItems(items); setItems(nextItems); setHasMore(nextItems.length < 300); }} > ); }; ``` Use `InfiScroller` on a custom scroll target (like a modal): ```javascript import React, { useState, useRef } from 'react'; import InfiScroller from 'react-infi-scroller'; const MyComponent = () => { const generateItems = (items = [], length = 30) => { const nextItems = [...items]; for (let i = 0; i < length; i += 1) { nextItems.push(items.length + i); } return nextItems; }; const [items, setItems] = useState(generateItems()); const [hasMore, setHasMore] = useState(true); const refComponent = useRef(null); return (
{ const nextItems = generateItems(items); setItems(nextItems); setHasMore(nextItems.length < 300); }} >
); }; ``` Use multiple `InfiScroller` components with custom scroll targets: ```javascript import React, { useState, useRef } from 'react'; import InfiScroller from 'react-infi-scroller'; const MyComponent = () => { const generateItems = (items = [], length = 30) => { const nextItems = [...items]; for (let i = 0; i < length; i += 1) { nextItems.push(items.length + i); } return nextItems; }; const [items, setItems] = useState(generateItems()); const [hasMore, setHasMore] = useState(true); const [otherItems, setOtherItems] = useState(generateItems()); const [hasMoreOther, setHasMoreOther] = useState(true); const refItemsWrapper = useRef(null); const refOtherItemsWrapper = useRef(null); /* Styles for the scroll targets used below */ return (
{ const nextItems = generateItems(items); setItems(nextItems); setHasMore(nextItems.length < 300); }} >
    {items.map((item) => (
  • {`Item ${item}`}
    • ))}
{ const nextOtherItems = generateItems(otherItems); setOtherItems(nextOtherItems); setHasMoreOther(nextOtherItems.length < 120); }} >
    {otherItems.map((otherItem) => (
  • {`Other Item ${otherItem}`}
    • ))}
); }; ``` Use `InfiScroller` with a spinner/loader: ```javascript import React, { useState } from 'react'; import InfiScroller from 'react-infi-scroller'; const MyComponent = () => { const generateItems = (items = [], length = 30) => { const nextItems = [...items]; for (let i = 0; i < length; i += 1) { nextItems.push(items.length + i); } return nextItems; }; const [items, setItems] = useState(generateItems()); const [hasMore, setHasMore] = useState(true); return ( { const nextItems = generateItems(items); setItems(nextItems); setHasMore(nextItems.length < 300); }} > {hasMore && ( Loading... )} ); }; ``` ## Props
Name Type Default Description
children Node | NodeList The content in the infinite scroller. Contains the list of items you want to trigger infinite scrolling for.
scrollTarget Node null The scroll target. Can be set to a custom scrollable node or omitted/null. When omitted/null the window object is used as scroll target.
debounceDelay Number 300 Debounce delay (in milliseconds) to optimize high-frequency scroll events. A recommended delay of 300 milliseconds is set by default.
gutter Number 10 Additional space (in pixels) used in the default shouldLoadMore calculation. Increasing it will cause the onLoadMore callback to be called before the scrollbar has reached the bottom of the scrollTarget. The larger the number, the earlier the onLoadMore callback will be called. A recommended minimum gutter of 10 pixels is set by default.
immediate Boolean false Whether to trigger an initial check, before any scroll event, if onLoadMore callback should be called. Set it to truewhen you want onLoadMore to be called immediately after the scrollTarget is mounted. This can be useful in case the scrollbar has been preset to the bottom of the scrollTarget or the content of the scrollTarget is less than its height and no scroll exist for it yet.
active Boolean true Turn on/off the infinite scroller. Keeps the component's children visible. Attaches event listeners when set to true. Detaches event listeners when set to false. Useful when the infinite scroller is placed inside a modal and you want it disabled until the modal is activated.
hasMore Boolean false Whether there are more items to load. This flag is used to determine if onLoadMore should be called. The entire check looks like this hasMore && shouldLoadMore(...).
shouldLoadMore 
(
 scrollTargetHeight: number,
 scrollYOffset: number,
 gutter: number,
 scrollHeight: number
) => boolean
 
(
 scrollTargetHeight,
 scrollYOffset,
 gutter,
 scrollHeight
) => (
  scrollTargetHeight
  + scrollYOffset
  + gutter
  >= scrollHeight
)
 Determine if more items should be loaded. By default a scrollTargetHeight + scrollYOffset + gutter >= scrollHeight formula is used. Provide a different function to customize this behavior. Note that shouldLoadMore will be called only if hasMore is true.
onLoadMore () => void Called when hasMore && shouldLoadMore(...) is true. You should load and render more items in the infinite scroller when onLoadMore is called.
--- _Source: https://npm.io/package/react-infi-scroller · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._