react-select-async-paginate

Wrapper above react-select that supports pagination on menu scroll.

Versions

This (react-select-async-paginate 0.2.x) is the version of react-select-async-paginate for use with react-select 2.x. For use with react-select 1.x you can install react-select-async-paginate 0.1.x.

Installation

npm install react-select react-select-async-paginate

or

yarn add react-select react-select-async-paginate

Usage

AsyncPaginate is an alternative of Select.Async but supports loading page by page. It is wrapper above default react-select thus it accepts all props of default Select except isLoading. And there are some new props:

• loadOptions

Required. Async function that take two arguments:

1. Current value of search input.
2. Loaded options for current search.

It should return next object:

{
  options: [{ label: 'label', value: 'value' }, ...],
  hasMore: true/false,
}

It similar to loadOptions from Select.Async but there is some differences:

1. Loaded options as 2nd argument.
2. Not supports callback.
3. Should return hasMore for detect end of options list for current search.

• cacheUniq

Not required. Can take any value. When this prop changed, AsyncPaginate cleans all cached options.

• selectRef

Ref for take react-select instance.

Example

import AsyncPaginate from 'react-select-async-paginate';

...

/*
 * assuming the API returns something like this:
 *   const json = {
 *     results: [
 *       {
 *         value: 1,
 *         label: 'Audi',
 *       },
 *       {
 *         value: 2,
 *         label: 'Mercedes',
 *       },
 *       {
 *         value: 3,
 *         label: 'BMW',
 *       },
 *     ],
 *     has_more: true,
 *   };
 */

async function loadOptions(search, loadedOptions) {
  const response = await fetch(`/awesome-api-url/?search=${search}&offset=${loadedOptions.length}`);
  const responseJSON = await response.json();

  return {
    options: responseJSON.results,
    hasMore: responseJSON.has_more,
  };
}

<AsyncPaginate
  value={value}
  loadOptions={loadOptions}
  onChange={setValue}
/>