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
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
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.
getSerializedValuefunc
A function to convert the currently selected values to a type accepted by HTML input. Used to set a value of a hidden input associated with the select, so that the selected values can be posted with a form.
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.
namestring
Name of the element. For example used by the server to identify the fields in form submits. If the name is provided, the component will render a hidden input element that can be submitted to a server.
onChangefunc
Callback fired when an option is selected.
onListboxOpenChangefunc
Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).
optionStringifierfuncdefaultOptionStringifier
A function used to convert the option label to a string. It's useful when labels are elements and need to be converted to plain text to enable navigation using character keys on a keyboard.
renderValuefunc
Function that customizes the rendering of the selected values.
slotProps{ listbox?: func
| object, popper?: func
| object, root?: func
| object }
{}
The props used for each slot inside the MultiSelect.
slots{ listbox?: elementType, popper?: elementType, root?: elementType }{}
The components used for each slot inside the MultiSelect. Either a string to use a HTML element or a component.
valuearray
The selected values. Set to an empty array to deselect all options.

The ref is forwarded to the root element.

Demos