MultiSelect
Custom searchable multi select
Source
LLM docs
Docs
Package
Made with Combobox
MultiSelect is an opinionated component built on top of the Combobox component. It has a limited set of features to cover only basic use cases. If you need more advanced features, you can build your own component with Combobox. You can find examples of custom multi select components on the examples page.
Usage
MultiSelect provides a way to enter multiple values.
MultiSelect is similar to TagsInput, but it does not allow entering custom values.
Loading state
Set loading prop to display a loading indicator. By default, the loader is displayed on the right side of the input.
You can change the position with the loadingPosition prop to 'left' or 'right'. This is useful for async operations like API calls, searches, or validations:
Controlled
The MultiSelect value must be an array of strings; other types are not supported.
The onChange function is called with an array of strings as a single argument.
Clearable
Set the clearable prop to display the clear button in the right section. The button is not displayed
when:
- The component does not have a value
- The component is disabled
- The component is read only
Clear section mode
The clearSectionMode prop determines how the clear button and rightSection are rendered:
'both'(default) – render both the clear button andrightSection'rightSection'– render only the user-suppliedrightSection, ignore clear button'clear'– render only the clear button, ignorerightSection
Searchable
Set the searchable prop to allow filtering options by user input:
Controlled search value
You can control the search value with the searchValue and onSearchChange props:
Nothing found
Set the nothingFoundMessage prop to display a given message when no options match the search query
or there is no data available. If the nothingFoundMessage prop is not set, the MultiSelect dropdown will be hidden.
Checked option icon
Set checkIconPosition prop to left or right to control position of check icon in active option.
To remove the check icon, set withCheckIcon={false}. To align unchecked labels with checked ones, set withAlignedLabels prop.
Max selected values
You can limit the number of selected values with the maxValues prop. This will not allow adding more values
once the limit is reached.
Hide selected options
To remove selected options from the list of available options, set the hidePickedOptions prop:
Data formats
MultiSelect data prop accepts data in one of the following formats:
Array of primitive values (strings, numbers, booleans):
Array of objects with value, label and optional disabled keys:
Array of groups with primitive value (string, number, boolean) options:
Array of groups with object options:
Value type
MultiSelect supports primitive values (strings, numbers, booleans) as value type. MultiSelect automatically
infers the value type. If you want to set the value type explicitly, pass type argument:
Options filtering
By default,MultiSelect filters options by checking if the option label contains the input value. You can change this behavior with the filter prop. The filter function receives an object with the following properties as a single argument:options– array of options or options groups, all options are in{ value: string; label: string; disabled?: boolean }formatsearch– current search querylimit– value of thelimitprop passed toMultiSelect
Example of a custom filter function that matches options by words instead of letter sequence:
Sort options
By default, options are sorted by their position in the data array. You can change this behavior
with the filter function:
Fuzzy search with fuse.js
You can implement fuzzy search using the fuse.js library to match options even with typos or partial matches:
Large data sets
The best strategy for large data sets is to limit the number of options that are rendered at the same time. You can do this with the limit prop. Note that if you use a custom filter function, you need to implement your own logic to limit the number of options in filter.
Example of MultiSelect with 100,000 options, 5 options are rendered at the same time:
renderOption
The renderOption callback allows you to customize option rendering. It is called with the option object and
checked state. The function must return a React node.
renderPill
The renderPill callback allows you to customize pill rendering. The function receives the option (that was passed to data), value, onRemove and disabled props. It must return a React node.
Scrollable dropdown
By default, the options list is wrapped with ScrollArea.Autosize.
You can control the dropdown max-height with the maxDropdownHeight prop if you do not change the default settings.
If you want to use native scrollbars, set withScrollArea={false}. Note that in this case,
you will need to change the dropdown styles with Styles API.
Group options
Disabled options
When an option is disabled, it cannot be selected and is ignored in keyboard navigation.
Note that the user can still enter a disabled option as a value. If you want to prohibit certain values,
use a controlled component and filter them out in the onChange function.
Combobox props
You can override Combobox props with comboboxProps. This is useful when you need to change some of the props that are not exposed by MultiSelect, for example withinPortal:
Change dropdown z-index
Inside Popover
To use MultiSelect inside popover, you need to set withinPortal: false:
Control dropdown opened state
You can control the dropdown opened state with the dropdownOpened prop. Additionally,
you can use onDropdownClose and onDropdownOpen to listen to dropdown opened state changes.
Dropdown position
By default, the dropdown is displayed below the input if there is enough space; otherwise it is displayed above the input.
You can change this behavior by setting the position and middlewares props, which are passed down to the
underlying Popover component.
Example of a dropdown that is always displayed above the input:
Dropdown width
To change the dropdown width, set the width prop in comboboxProps. By default,
the dropdown width is equal to the input width.
Dropdown offset
To change the dropdown offset, set the offset prop in comboboxProps:
Dropdown animation
By default, dropdown animations are disabled. To enable them, you can set transitionProps,
which will be passed down to the underlying Transition component.
Dropdown padding
Dropdown shadow
Left and right sections
MultiSelect supports leftSection and rightSection props. These sections are rendered with absolute positioning inside the input wrapper. You can use them to display icons, input controls, or any other elements.
You can use the following props to control sections styles and content:
rightSection/leftSection– React node to render on the corresponding side of inputrightSectionWidth/leftSectionWidth– controls the width of the right section and padding on the corresponding side of the input. By default, it is controlled by the componentsizeprop.rightSectionPointerEvents/leftSectionPointerEvents– controls thepointer-eventsproperty of the section. If you want to render a non-interactive element, set it tononeto pass clicks through to the input.
Input props
MultiSelect component supports Input and Input.Wrapper component features and all input element props. The MultiSelect documentation does not include all features supported by the component – see the Input documentation to learn about all available features.
Input description
Read only
Set readOnly to make the input read-only. When readOnly is set,
MultiSelect will not show suggestions and will not call the onChange function.
Disabled
Set disabled to disable the input. When disabled is set,
the user cannot interact with the input and MultiSelect will not show suggestions.
Error state
Invalid name
Styles API
MultiSelect supports the Styles API; you can add styles to any inner element of the component with the classNames prop. Follow the Styles API documentation to learn more.
Description
Component Styles API
Hover over selectors to highlight corresponding elements
Get element ref
Accessibility
If MultiSelect is used without the label prop, it will not be announced properly by screen readers:
Set aria-label to make the input accessible. In this case the label will not be visible, but screen readers will announce it:
If the label prop is set, the input will be accessible and it is not required to set aria-label:
To set aria-label on the clear button, use clearButtonProps. Note that it is required
only when clearable is set.
Backspace key
When the search input is empty and the user presses the Backspace key, the last selected item is removed. This behavior is built-in and cannot be disabled.