JSPM

  • Created
  • Published
  • Downloads 19383
  • Score
    100M100P100Q136380F
  • License MIT

React powered selectbox with filter

Package Exports

  • react-select-search

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-select-search) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React Select Search

React powered selectbox with filter using fuse.js (Javascript fuzzy-search).

Example design comes from the beautiful work by Rovane Durso.

Demo

Live demo can be found here: http://tbleckert.github.io/react-select-search/

How to use

Install it with npm (npm install react-select-search --save) and require it like you normally would.

React.render(
    <SelectSearch
        name="country"
        value="SE"
        placeholder="Choose country"
        search={true}
        multiple={false}
        height={height in pixels, used if multiple select}
        className="my-selectbox"
        options={objectWithOptions}
        fuse={fuseJsOptions}
        optionSelected={callbackWhenOptionMarked}
        valueChanged={callbackWhenValueChanged}
        renderOption={modifyOptionHtml}
        onMount={componentDidMountCallback}
        onFocus={searchFocusCallback}
        onBlur={searchBlurCallback} />,
    document.getElementById('selectSearch')
);

These are all available options. The React component renders a hidden field with the name property and the current value to use in forms.

You will also need some CSS to make it look right. The important piece is the options.

/** The option list should not be visible by default */
.select-search-box__select {
    display: none;
}

    /** If it's a multiple select, you can style it with this selector */
    .select-search-box--multiple .select-search-box__select {
        display: block;
    }

    /** The list receives the modifier class "display" when the select has focus */
    .select-search-box__select--display {
        display: block;
    }

    /**
     * The option list hides when the selectbox loses focus.
     * To prevent the list from dissapearing before the option click event
     * we use a timer that hides it after 200ms.
     * To make it look like it dissapears right away
     * you can use this class and set opacity to 0
     *
     * I found that using the mousedown event wasn't a good option.
     */
     .select-search-box__select--prehide {
         opacity: 0;
     }

/** UL with the options */
.select-search-box__options {

}

/** The option (LI), look at the state classes below */
.select-search-box__option {

}

    /** When the option has been selected */
    .select-search-box__option--selected {

    }

    /** When the option is selected (when navigation with the arrow keys, up/down) */
    .select-search-box__option--hover, .select-search-box__option:hover {

    }