Custom searchable multi select
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 .
MultiSelect provides a way to enter multiple values. MultiSelect is similar to TagsInput , but it does not allow entering custom values.
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:
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.
Set the clearable prop to display the clear button in the right section. The button is not displayed when:
The clearSectionMode prop determines how the clear button and rightSection are rendered:
Set the searchable prop to allow filtering options by user input:
You can control the search value with the searchValue and onSearchChange props:
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.
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.
You can limit the number of selected values with the maxValues prop. This will not allow adding more values once the limit is reached.
To remove selected options from the list of available options, set the hidePickedOptions prop:
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:
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:
Example of a custom filter function that matches options by words instead of letter sequence:
By default, options are sorted by their position in the data array. You can change this behavior with the filter function:
You can implement fuzzy search using the fuse.js library to match options even with typos or partial matches:
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:
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.
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.
Set the withPillsReorder prop to allow reordering pills. Dropping a pill before or after another pill updates the component value accordingly. Reordering is automatically disabled when disabled or readOnly is set.
You can reorder pills with a mouse (drag-and-drop) or keyboard:
Focus follows the moved pill so multiple moves can be chained without re-focusing.
Selected values can be reordered by dragging pills
If you use a custom pill renderer with the renderPill prop, spread the reorderProps from the render callback payload onto the focusable pill root element to keep reordering working. reorderProps carries the tabIndex , data-mantine-pill-index attribute and the keyboard handler that drive keyboard reorder, so it must land on the element the user can focus:
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 .
Set floatingHeight="viewport" to make the dropdown grow to fill the available vertical space in the viewport. The flip middleware is disabled in this mode – the dropdown always opens in the configured direction and is constrained to the viewport edges instead of flipping to the other side. Useful when working with large option lists:
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.
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 :
To use MultiSelect inside popover, you need to set withinPortal: false :
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.
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:
To change the dropdown width, set the width prop in comboboxProps . By default, the dropdown width is equal to the input width.
To change the dropdown offset, set the offset prop in comboboxProps :
By default, dropdown animations are disabled. To enable them, you can set transitionProps , which will be passed down to the underlying Transition component.
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:
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.
Set readOnly to make the input read-only. When readOnly is set, MultiSelect will not show suggestions and will not call the onChange function.
Set disabled to disable the input. When disabled is set, the user cannot interact with the input and MultiSelect will not show suggestions.
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.
Component Styles API
Hover over selectors to highlight corresponding elements
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.
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.