JSPM

  • Created
  • Published
  • Downloads 424887
  • Score
    100M100P100Q157666F

Package Exports

  • react-list

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-list) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ReactList

A versatile infinite scroll React component.

Install

bower install react-list

API

Properties

items

The list of items to be rendered.

renderItem

A function that receives and item (and its relative index) and returns the content to be rendered for that item.

renderLoading

A function that should return a loading message.

renderError

A function that receives an error from a failed fetch and should return an error message.

renderEmpty

A function that should return a message when no items are available to render.

renderPageSize (defaults to 10)

A number that specifies how many items to render per page (this is calculated automatically for uniform items).

threshold (defaults to 500)

The number of pixels to ensure the top and bottom of the list is buffered with.

uniform (defaults to false)

A boolean that specifies whether or not the rendered items are of uniform width and height. Uniform items allow space to be preallocated on the page without actually rendering the items.

fetch

A function that receives the current list of items and a callback. The callback should be invoked when the fetch is complete with the error (if any) as the first argument and a boolean determining whether the entire list is fetched or not.

Examples

Check out the test file for a full example.

Known Issues

  • Paging should be supported, but isn't yet.