Redux Infinite Scroll

A stateless React infinite scroll component meant for usage within Redux.

Demo & Examples

http://realscout.github.io/redux-infinite-scroll/

Installation

npm install redux-infinite-scroll --save

Importing Via AMD/CommonJS

ES6 format

import ReduxInfiniteScroll from 'redux-infinite-scroll';

ES5 format

var ReduxInfiniteScroll = require('redux-infinite-scroll');

Importing Via Script Tag

If you decide to use either one of the distribution files found in /dist, then you can access the ReduxInfiniteScroll via a global variable.

ES6 format

ReduxInfiniteScroll

ES5 format

ReduxInfiniteScroll.default;

The difference is due to the ReduxInfiniteScroll being an ES6 module and therefore having a different export syntax than ES5.

Usage

In order to use it in your React app, simply import it and follow the example below. The component expects to receive child elements that it then injects into the DOM. The loadMore prop expects a function that requests for more items to be loaded once the container/window has reached the bottom threshold. If there are no more items left to be passed to the component, make sure to set the hasMore prop to be false. Important If you are using an element as the scrollable component, rather than the window, you MUST pass a fixed height to the containerHeight prop.

ES6 format

 
// MessageList.jsx
 
import InfiniteScroll from 'redux-infinite-scroll';
import ChatActions from './ChatActions';
 
class MessageList extends Component {
  _loadMore() {
    this.props.dispatch(ChatActions.fetchMessages())
  }
  
  _renderMessages() {
    return _.map(this.props.messages, (msg) => {
      return(
          <div>{msg}</div>
      )
    })
  }
  
  render() {
    return (
        <InfiniteScroll
          items={this._renderMessages.bind(this)}
          loadMore={this._loadMore.bind(this)}
        />
    )
  }
}
 

Where your Redux action and reducer might look something like this:

// ChatActions.js
 
export function fetchMessages(params) {
  return {
    type: FETCH_MESSAGES,
    messages: ['hi there', 'hi again', 'still here']
  };
}
 
 
// ChatReducer.js
 
 
const initialState = {
  messages: []
}
 
function chatReducer(state=initialState, action=undefined) {
  switch (action.type) {
    case FETCH_MESSAGES:
      return Object.assign({}, initialState, {
        messages: initialState.concat(action.messages)
      })
  }
}
 

Options

Credits

RealScout Heavily inspired by react-infinite-scroll.

License

MIT Licensed. Copyright (c) RealScout Inc.