React Infi Scroller
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:
;
Use InfiScroller
on the window object:
;; const MyComponent = { const generateItems = { const nextItems = ...items; for let i = 0; i < length; i += 1 nextItems; return nextItems; }; const items setItems = ; const hasMore setHasMore = ; return <InfiScroller hasMore=hasMore onLoadMore= { const nextItems = ; ; ; } > <ul> items </ul> </InfiScroller> ;};
Use InfiScroller
on a custom scroll target (like a modal):
;; const MyComponent = { const generateItems = { const nextItems = ...items; for let i = 0; i < length; i += 1 nextItems; return nextItems; }; const items setItems = ; const hasMore setHasMore = ; const refComponent = ; return <div ref=refComponent> <InfiScroller scrollTarget=refComponentcurrent hasMore=hasMore onLoadMore= { const nextItems = ; ; ; } > <ul> items </ul> </InfiScroller> </div> ;};
Use multiple InfiScroller
components with custom scroll targets:
;; const MyComponent = { const generateItems = { const nextItems = ...items; for let i = 0; i < length; i += 1 nextItems; return nextItems; }; const items setItems = ; const hasMore setHasMore = ; const otherItems setOtherItems = ; const hasMoreOther setHasMoreOther = ; const refItemsWrapper = ; const refOtherItemsWrapper = ; /* Styles for the scroll targets used below <style> .items-scroller { height: 300px; overflow: auto; background-color: white; } .other-items-scroller { height: 500px; margin-top: 40px; overflow: auto; background-color: white; } </style> */ return <div> <div ref=refItemsWrapper className="items-scroller" > <InfiScroller scrollTarget=refItemsWrappercurrent hasMore=hasMore onLoadMore= { const nextItems = ; ; ; } > <ul> items </ul> </InfiScroller> </div> <div ref=refOtherItemsWrapper className="other-items-scroller" > <InfiScroller scrollTarget=refOtherItemsWrappercurrent hasMore=hasMoreOther onLoadMore= { const nextOtherItems = ; ; ; } > <ul> otherItems </ul> </InfiScroller> </div> </div> ;};
Use InfiScroller
with a spinner/loader:
;; const MyComponent = { const generateItems = { const nextItems = ...items; for let i = 0; i < length; i += 1 nextItems; return nextItems; }; const items setItems = ; const hasMore setHasMore = ; return <InfiScroller hasMore=hasMore onLoadMore= { const nextItems = ; ; ; } > <ul> items </ul> hasMore && <span>Loading...</span> </InfiScroller> ;};
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 true when 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. |