react-selectize

React Selectize

ReactSelectize is a stateless Select component for ReactJS, that provides a platform for the more developer friendly SimpleSelect & MultiSelect components.

Both SimpleSelect & MultiSelect have been designed to work as drop in replacement for the built-in React.DOM.Select component.

styles & features inspired by React Select & Selectize.

DEMO / Examples: furqanZafar.github.io/react-selectize

• Changelog (last updated on 1st February 2016)
• API Reference

Motivation

• existing components do not behave like built-in React.DOM.* components.
• existing components synchronize props with state an anti pattern, which makes them prone to bugs & difficult for contributers to push new features without breaking something else.
• more features.

Features

• Drop in replacement for React.DOM.Select
• Stateless, therefore extremely flexible & extensible
• Clean and compact API fully documented on GitHub
• Multiselect support
• Option groups
• Custom filtering & option object
• Search highlighting
• Custom option & value rendering
• Animated dropdown
• Remote data loading
• Tagging or item creation
• Restore on backspace
• Editable value
• Caret between items
• Customizable dropdown direction
• Mark options as unselectable
• Disable selected values
• Absolute positioned overlay, "Tether"ed to the search field
• Customizable styles, comes with Stylus files

Install

npm install react-selectize

Usage (livescript)

{create-factory}:React = require \react
{SimpleSelect, MultiSelect, ReactSelectize} = require \react-selectize
SimpleSelect = create-factory SimpleSelect
MultiSelect = create-factory MultiSelect
.
.
.
SimpleSelect do     
    placeholder: 'Select a fruit'
    options: <[apple mango orange banana]> |> map ~> label: it, value: it
    on-value-change: (value) ~>
        alert value
.
.
.
MultiSelect do
    placeholder: 'Select fruits'
    options: <[apple mango orange banana]> |> map ~> label: it, value: it
    on-values-change: (values) ~>
        alert values

Usage (jsx)

React = require("react");
ReactSelectize = require("react-selectize");
SimpleSelect = ReactSelectize.SimpleSelect;
MultiSelect = ReactSelectize.MultiSelect;
.
.
.
<SimpleSelect
    placeholder = "Select a fruit"
    onValueChange = {function(value){
        alert(value);        
    }}
>
    <option value = "apple">apple</option>
    <option value = "mango">mango</option>
    <option value = "orange">orange</option>
    <option value = "banana">banana</option>
</SimpleSelect>
.
.
.
// Note: options can be passed as props as well, for example
<MultiSelect
    placeholder = "Select fruits"
    options = ["apple", "mango", "orange", "banana"].map(function(fruit){
        return {label: fruit, value: fruit};
    });
    onValuesChange = {function(values){
        alert(values);
    }}
/>

Usage (stylus)

to include the default styles add the following import statement to your stylus file:

@import 'node_modules/react-selectize/src/index.css'

Gotchas

• the default structure of an option object is {label: String, value :: a} where a implies that value property can be of any equatable type

• SimpleSelect notifies change via onValueChange prop whereas MultiSelect notifies change via onValuesChange prop

• the onValueChange callback for SimpleSelect is passed 1 parameter. the selected option object (instead of the value property of the option object)

• the onValuesChange callback for MultiSelect is passed 1 parameter an Array of selected option objects (instead of a collection of the value properties or a comma separated string of value properties)

• both the SimpleSelect & MultiSelect will manage the open, search, value & anchor props using internal state, if they are not provided via props: when passing open, search, value or anchor via props, you must update them on*Change (just like in the case of standard react html input components)

value = {state.selectedValue}
onValueChange = {function(value){
    self.setState({selectedValue: value});
}}
search = {state.search}
onSearchChange = {function(value){    
    self.setState({search: value});
}}

• when using custom option object, you should implement the uid function which accepts an option object and returns a unique id, for example:

// assuming the type of our option object is:
// {firstName :: String, lastName :: String, age :: Int}
uid = {function(item){
    return item.firstName + item.lastName;    
}}

the uid function is used internally for performance optimization.

Deps

• tether

Peer Deps

• react
• react-dom
• react-addons-css-transition
• react-addons-shallow-compare

Development

• npm install
• gulp
• visit localhost:8000
• npm test , npm run coverage for unit tests & coverage
• for production build/test run MINIFY=true gulp

Changelog

v0.6.1 / 1st February 2016

• disable keyboard selection when control or command keys are pressed
• minor css improvements