https://github.com/insin/react-filtered-multiselect
Filtered multi-select React component
https://github.com/insin/react-filtered-multiselect
form-input multi-select react react-component
Last synced: 9 months ago
JSON representation
Filtered multi-select React component
- Host: GitHub
- URL: https://github.com/insin/react-filtered-multiselect
- Owner: insin
- License: mit
- Created: 2014-11-13T13:44:12.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2021-05-31T10:50:27.000Z (about 5 years ago)
- Last Synced: 2025-08-09T04:16:18.809Z (10 months ago)
- Topics: form-input, multi-select, react, react-component
- Language: JavaScript
- Homepage: http://insin.github.io/react-filtered-multiselect
- Size: 85.9 KB
- Stars: 61
- Watchers: 3
- Forks: 25
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# react-filtered-multiselect
[![Travis][build-badge]][build]
[![npm package][npm-badge]][npm]
A `` React component, for making and adding to selections using a filtered multi-select.
[Live example with Bootstrap styles applied](http://insin.github.io/react-filtered-multiselect/)
## Features
This component manages an ``, a `` and a ``.
You provide a list of objects to be used to populate the select and an `onChange` callback function.
Typing in the the input will filter the select to items with matching option text.
When some of the select's options are selected, the button will become enabled. Clicking it will select the objects backing the currently selected options.
If only one option is displayed after filtering against the input, pressing Enter in the input will select the object backing it.
When backing objects are selected, the `onChange` callback is executed, passing a list of all backing objects selected so far.
To hide already-selected items, pass them back to `FilteredMultiSelect` as its `selectedOptions` prop. This can be more convenient than manually removing the selected items from the list passed as `options`.
To deselect items, remove them from the list passed back via the `onChange` callback and re-render the `FilteredMultiSelect` with the new list passed as its `selectedOptions` prop.
Double-clicking will add the selected option to the selection.
## Install
**Node**
```
npm install react-filtered-multiselect
```
```javascript
import FilteredMultiSelect from 'react-filtered-multiselect'
// or
const FilteredMultiSelect = require('react-filtered-multiselect')
```
**Browser**
Browser bundles export a global ``FilteredMultiSelect`` variable and expect to find a global ``React`` variable to work with.
* [react-filtered-multiselect.js](https://unpkg.com/react-filtered-multiselect/umd/react-filtered-multiselect.js) (development version)
* [react-filtered-multiselect.min.js](https://unpkg.com/react-filtered-multiselect/umd/react-filtered-multiselect.min.js) (compressed production version)
## API
### Required props
Minimal usage:
```js
let options = [
{value: 1, text: 'Item One'},
{value: 2, text: 'Item Two'}
]
```
`options` - list of objects providing `` data for the multi-select. By default, these should have ``text`` and ``value`` properties, but this is configurable via props.
The component will update its display if its `options` list changes length or is replaced with a different list, but it will *not* be able to detect changes which don't affect length or object equality, such as replacement of one option with another. Consider using [immutability-helper](https://github.com/kolodny/immutability-helper) or other immutability libraries if you need to do this.
`onChange(selectedOptions)` - callback which will be called with selected option objects each time the selection is added to.
### Optional props
`buttonText` - text to be displayed in the `` for adding selected ``s.
`className` - class name for the component's `
` container.
`classNames` - class names for each of the component's child elements. See the default props below for properties. Defaults will be used for any properties not specified via this prop.
`defaultFilter` - default filter text to be applied to the ``
`disabled` - disables each child element if `true`.
`placeholder` - placeholder text to be displayed in the filter ``.
`selectedOptions` - list of option objects which are selected, so should no
longer be displayed in the ``.
`showFilter` - pass `false` to disable showing the filter input if you just use this component for selection.
`size` - `size` attribute for the ``
`textProp` - name of the property in each object in `options` which provides
the displayed text for its ``.
`valueProp` - name of the property in each object in `options` which provides
the `value` for its ``.
### Default props
```js
{
buttonText: 'Select',
className: 'FilteredMultiSelect',
classNames: {
button: 'FilteredMultiSelect__button',
// Used when at least one is selected
buttonActive: 'FilteredMultiSelect__button--active',
filter: 'FilteredMultiSelect__filter',
select: 'FilteredMultiSelect__select'
}
defaultFilter: '',
disabled: false,
placeholder: 'type to filter',
selectedOptions: [],
showFilter: true,
size: 6,
textProp: 'text',
valueProp: 'value'
}
```
## Example
Example which implements display of selected items and de-selection.
```js
const CULTURE_SHIPS = [
{id: 1, name: '5*Gelish-Oplule'},
{id: 2, name: '7*Uagren'},
// ...
{id: 249, name: 'Zero Gravitas'},
{id: 250, name: 'Zoologist'}
]
class Example extends React.Component {
state = {selectedShips: []}
handleDeselect(index) {
var selectedShips = this.state.selectedShips.slice()
selectedShips.splice(index, 1)
this.setState({selectedShips})
}
handleSelectionChange = (selectedShips) => {
this.setState({selectedShips})
}
render() {
var {selectedShips} = this.state
return
{selectedShips.length === 0 && (nothing selected yet)
}
{selectedShips.length > 0 &&
{selectedShips.map((ship, i) => -
{`${ship.name} `}
this.handleDeselect(i)}>
×
)}
}
}
}
```
## MIT Licensed
[build-badge]: https://img.shields.io/travis/insin/react-filtered-multiselect/master.png?style=flat-square
[build]: https://travis-ci.org/insin/react-filtered-multiselect
[npm-badge]: https://img.shields.io/npm/v/react-filtered-multiselect.png?style=flat-square
[npm]: https://www.npmjs.org/package/react-filtered-multiselect