SelectUnstyled API
API documentation for the React SelectUnstyled component. Learn about the available props and the CSS API.
Import
import SelectUnstyled from '@mui/base/SelectUnstyled';
// or
import { SelectUnstyled } from '@mui/base';
The foundation for building custom-styled select components.
Props
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
autoFocus | bool | false | 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. |
defaultListboxOpen | bool | false | If true , the select will be initially open. |
defaultValue | any | The default selected value. Use when the component is not controlled. | |
disabled | bool | false | If true , the select is disabled. |
listboxId | string | id attribute of the listbox element. Also used to derive the id attributes of options. | |
listboxOpen | bool | undefined | Controls the open state of the select's listbox. |
onChange | func | Callback fired when an option is selected. | |
onListboxOpenChange | func | Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen). | |
renderValue | func | Function that customizes the rendering of the selected value. | |
value | any | The selected value. Set to null to deselect all options. |
The
ref
is forwarded to the root element.