Select API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Select

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

Name	Type	Default	Description
action	func \| { current?: { focusVisible: func } }	-	A ref for imperative actions. It currently only supports `focusVisible()` action.
autoFocus	bool	false	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.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
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 component is disabled.
endDecorator	node	-	Trailing adornment for the select.
getSerializedValue	func	-	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.
indicator	node	-	The indicator() for the select. ________________ [ value ] ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
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.
multiple	bool	-	If `true`, selecting multiple values is allowed. This affects the type of the `value`, `defaultValue`, and `onChange` props.
name	string	-	Name of the element. For example used by the server to identify the fields in form submits.
onChange	func	-	Callback fired when an option is selected.
onClose	func	-	Triggered when focus leaves the menu and the menu should close.
onListboxOpenChange	func	-	Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).
placeholder	node	-	Text to show when there is no selected value.
renderValue	func	-	Function that customizes the rendering of the selected value.
required	bool	false	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.
startDecorator	node	-	Leading adornment for the select.
sx	Array<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.
value	any	-	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 name	Class name	Default component	Description
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 name	Rule name	Description
.Mui-disabled		State class applied to the root slot if `disabled={true}`.
.Mui-expanded		State class applied to the root slot if listbox open.
.Mui-focusVisible		State class applied to the SelectBase root slot if the button is keyboard focused.
.MuiSelect-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiSelect-colorDanger	colorDanger	Class name applied to the root slot if `color="danger"`.
.MuiSelect-colorNeutral	colorNeutral	Class name applied to the root slot if `color="neutral"`.
.MuiSelect-colorPrimary	colorPrimary	Class name applied to the root slot if `color="primary"`.
.MuiSelect-colorSuccess	colorSuccess	Class name applied to the root slot if `color="success"`.
.MuiSelect-colorWarning	colorWarning	Class name applied to the root slot if `color="warning"`.
.MuiSelect-multiple	multiple	Class name applied to the root slot if `multiple=true`
.MuiSelect-popper	popper	Class name applied to the popper slot.
.MuiSelect-sizeLg	sizeLg	Class name applied to the root slot if `size="lg"`.
.MuiSelect-sizeMd	sizeMd	Class name applied to the root slot if `size="md"`.
.MuiSelect-sizeSm	sizeSm	Class name applied to the root slot if `size="sm"`.
.MuiSelect-variantOutlined	variantOutlined	Class name applied to the root slot if `variant="outlined"`.
.MuiSelect-variantPlain	variantPlain	Class name applied to the root slot if `variant="plain"`.
.MuiSelect-variantSoft	variantSoft	Class name applied to the root slot if `variant="soft"`.
.MuiSelect-variantSolid	variantSolid	Class name applied to the root slot if `variant="solid"`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

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.