react-windowed-select

!example workflow
[![npm package][npm-badge]][npm]
[![Storybook][storybook-badge]][storybook]

An integration of react-window with react-select to efficiently render large lists.

Installation and Usage

The easiest way to use react-windowed-select is to install it from npm:

``
npm install react-windowed-select
`

Then use it in your app:

`javascript
import React from "react";
import WindowedSelect from "react-windowed-select";

const options = [];

for (let i = 0; i < 10000; i += 1) {
options.push({
label: Option ${i},
value: i
});
}

function App () {
return ;
}
`

![Edit react-windowed-select](https://codesandbox.io/s/n592j4l13m)

For more examples, check out the [Storybook][storybook].

Props

react-windowed-select is just a wrapper around react-select.
All props passed to the WindowedSelect component are forwarded to the default exported Select component
from react-select.

$3

The number of options beyond which the menu will be windowed.

Named Exports


All of the named exports from react-select are re-exported from react-windowed-select for easy access to features
that allow you to customize your Select component.

`javascript
import { components, createFilter } from 'react-windowed-select';
import React from "react";

const options = [
{ value: 1, label: 'Foo' },
{ value: 2, label: 'Bar '},
];

const customFilter = createFilter({ ignoreAccents: false });
const customComponents = {
ClearIndicator: (props) => clear
};

function App () {
return (
components={customComponents}
isClearable={true}
filterOption={customFilter}
options={options}
/>
);
}
`
![Edit react-windowed-select custom filter and component](https://codesandbox.io/s/sweet-snowflake-evjeo?fontsize=14)

$3


By default, react-windowed-select wraps the standard Select component from react-select.
If you want to add windowing to the Async or Creatable Select components from react-select, use the WindowedMenuList:

`javascript
import { WindowedMenuList } from 'react-windowed-select';
import CreatableSelect from 'react-select/creatable';

function App () {
return (
components={{ MenuList: WindowedMenuList }}
// ...other props
/>
);
}
`

Custom Styles

You can still use the styles API from react-select to customize how your Select component looks.
The height property of the Option, GroupHeading, NoOptionsMessage and/or LoadingMessage components is used to determine the total height of the windowed menu and the following defaults are provided:

|Component |Default Height|
|------------------|--------------|
|Option |35px |
|GroupHeading |25px |
|NoOptionsMessage|35px |
|LoadingMessage |35px |

To override these values, use the styles prop like you would with a regular react-select component.

`javascript
options={options}
styles={{
option: (base) => ({
...base,
height: 60, // must be type number
padding: '20px 12px',
}),
}}
/>
`

Grouped Options

Grouped options are not fully supported.
In order to ensure proper scrolling and focus behavior, options nested inside the Group component are flattened. This changes the component structure within MenuList in the following way:

`
MenuList
│
└───Group
│ │
| └───GroupHeading
|
└───Option 1
|
└───Option 2
``

[build-badge]: https://img.shields.io/travis/jacobworrel/react-windowed-select/master.png?style=flat-square
[build]: https://travis-ci.org/jacobworrel/react-windowed-select

[npm-badge]: https://img.shields.io/npm/v/react-windowed-select.png?style=flat-square
[npm]: https://www.npmjs.com/package/react-windowed-select

[coveralls-badge]: https://img.shields.io/coveralls/jacobworrel/react-windowed-select/master.png?style=flat-square
[coveralls]: https://coveralls.io/github/jacobworrel/react-windowed-select

[storybook-badge]: https://github.com/storybooks/brand/blob/master/badge/badge-storybook.svg
[storybook]: https://peaceful-leavitt-38971b.netlify.com