Skip to content

MultiSelectUnstyled API

API documentation for the React MultiSelectUnstyled component. Learn about the available props and the CSS API.

Import

import MultiSelectUnstyled from '@mui/base/MultiSelectUnstyled';
// or
import { MultiSelectUnstyled } from '@mui/base';
You can learn about the difference by reading this guide on minimizing bundle size.

The foundation for building custom-styled multi-selection select components.

Props

Props of the native component are also available.

NameTypeDefaultDescription
autoFocusboolfalse
If true, the select element is focused during the first mount
components{ Listbox?: elementType, Popper?: elementType, Root?: elementType }{}
The components used for each slot inside the Select. Either a string to use a HTML element or a component.
componentsProps{ listbox?: func
| object, popper?: func
| object, root?: func
| object }
{}
The props used for each slot inside the Input.
defaultListboxOpenboolfalse
If true, the select will be initially open.
defaultValuearray[]
The default selected values. Use when the component is not controlled.
disabledboolfalse
If true, the select is disabled.
listboxIdstring
id attribute of the listbox element. Also used to derive the id attributes of options.
listboxOpenboolundefined
Controls the open state of the select's listbox.
onChangefunc
Callback fired when an option is selected.
onListboxOpenChangefunc
Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).
renderValuefunc
Function that customizes the rendering of the selected values.
valuearray
The selected values. Set to an empty array to deselect all options.

The ref is forwarded to the root element.

Demos