react-select-quick-score v0.0.5

react-select + quick-score

react-select-quick-score adds smart autocomplete to react-select using QuickScore.

Instead of the limited type-ahead available in react-select components, where the user has to type an exact substring to match a menu item, QuickScore lets users type just a few letters to quickly display a list of sensible results, sorted by how well the query matches. See a demo

QuickScore is fast, dependency-free, and is just 2KB when minified and gzipped, so it adds only a little weight to react-select.

Install

npm install react-select-quick-score

The project must also include react-select v5 and React v16.8 or later.

Usage

To create a select element with smart autocomplete, import the SelectQS component from the package:

import React from 'react';
import { SelectQS } from 'react-select-quick-score';

const options = [
  { value: 'chocolate', label: 'Chocolate' },
  { value: 'strawberry', label: 'Strawberry' },
  { value: 'vanilla', label: 'Vanilla' }
];

const MyComponent = () => (
  <SelectQS options={options} />
);

SelectQS is a drop-in replacement for Select from react-select, and it supports all of the same props. The difference comes when the user starts typing to find an item in the menu.

Unlike the default react-select behavior, the SelectQS items are sorted by how well they match the user's query, making it easier to find the desired item. The query also doesn't have to be an exact substring of an item. Matches against capital letters and the beginnings of words score higher, so the user could type gh, for example, to match items that include GitHub. That query would not match the same items in the Select element.

If the select options are organized into groups, each group is sorted and filtered independently, separated by the group labels. Groups with no matching items are hidden.

Differences with react-select

When the query is empty, QuickScore sorts its list of items alphabetically and case-insensitively. So the options displayed in a SelectQS component will be listed alphabetically by default, regardless of their order in the options prop.

The filterOption prop is ignored, since QuickScore manages the sorting and filtering of options.

If the options list includes both grouped and ungrouped items (which is not a typical use case), the ungrouped items will all appear before the first group, regardless of where they appear in the options prop. This is done so the ungrouped options can be filtered and sorted together. (In the default Select component, ungrouped options can appear between or after grouped ones.)

License

MIT © John Dunning