Skip to content

Select API

API reference docs for the React Select component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import Select from '@mui/joy/Select';
// or
import { Select } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
actionfunc
| { current?: { focusVisible: func } }
-

A ref for imperative actions. It currently only supports focusVisible() action.

autoFocusboolfalse

If true, the select element is focused during the first mount

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'neutral'

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

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.

defaultValueany-

The default selected value. Use when the component is not controlled.

disabledboolfalse

If true, the component is disabled.

endDecoratornode-

Trailing adornment for the select.

getSerializedValuefunc-

A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form.

indicatornode-

The indicator(*) for the select. ________________ [ value * ] ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾

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.

multiplebool-

If true, selecting multiple values is allowed. This affects the type of the value, defaultValue, and onChange props.

namestring-

Name of the element. For example used by the server to identify the fields in form submits.

onChangefunc-

Callback fired when an option is selected.

onClosefunc-

Triggered when focus leaves the menu and the menu should close.

onListboxOpenChangefunc-

Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).

placeholdernode-

Text to show when there is no selected value.

renderValuefunc-

Function that customizes the rendering of the selected value.

requiredboolfalse

If true, the Select cannot be empty when submitting form.

size'sm'
| 'md'
| 'lg'
| string
-

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

slots{ button?: elementType, endDecorator?: elementType, indicator?: elementType, listbox?: elementType, root?: elementType, startDecorator?: elementType }{}

The components used for each slot inside.

See Slots API below for more details.

startDecoratornode-

Leading adornment for the select.

sxArray<func
| object
| bool>
| func
| object
-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

valueany-

The selected value. Set to null to deselect all options.

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
'outlined'

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoySelect to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot nameClass nameDefault componentDescription
root.MuiSelect-root'div'The component that renders the root.
button.MuiSelect-button'button'The component that renders the button.
startDecorator.MuiSelect-startDecorator'span'The component that renders the start decorator.
endDecorator.MuiSelect-endDecorator'span'The component that renders the end decorator.
indicator.MuiSelect-indicator'span'The component that renders the indicator.
listbox.MuiSelect-listbox'ul'The component that renders the listbox.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-disabledState class applied to the root slot if disabled={true}.
.Mui-expandedState class applied to the root slot if listbox open.
.Mui-focusVisibleState class applied to the SelectBase root slot if the button is keyboard focused.
.MuiSelect-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiSelect-colorDangercolorDangerClass name applied to the root slot if color="danger".
.MuiSelect-colorNeutralcolorNeutralClass name applied to the root slot if color="neutral".
.MuiSelect-colorPrimarycolorPrimaryClass name applied to the root slot if color="primary".
.MuiSelect-colorSuccesscolorSuccessClass name applied to the root slot if color="success".
.MuiSelect-colorWarningcolorWarningClass name applied to the root slot if color="warning".
.MuiSelect-multiplemultipleClass name applied to the root slot if multiple=true
.MuiSelect-popperpopperClass name applied to the popper slot.
.MuiSelect-sizeLgsizeLgClass name applied to the root slot if size="lg".
.MuiSelect-sizeMdsizeMdClass name applied to the root slot if size="md".
.MuiSelect-sizeSmsizeSmClass name applied to the root slot if size="sm".
.MuiSelect-variantOutlinedvariantOutlinedClass name applied to the root slot if variant="outlined".
.MuiSelect-variantPlainvariantPlainClass name applied to the root slot if variant="plain".
.MuiSelect-variantSoftvariantSoftClass name applied to the root slot if variant="soft".
.MuiSelect-variantSolidvariantSolidClass name applied to the root slot if variant="solid".

You can override the style of the component using one of these customization options:

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.