Skip to content
Edit this page

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:

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

action

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

Type:

func | { current?: { focusVisible: func } }
autoFocus

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

Type:

bool
color

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

Type:

'danger' | 'info' | 'neutral' | 'primary' | 'success' | 'warning' | string
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
defaultListboxOpen

If true, the select will be initially open.

Type:

bool
defaultValue

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

Type:

any
disabled

If true, the component is disabled.

Type:

bool
endDecorator

Trailing adornment for the select.

Type:

node
getSerializedValue

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.

Type:

func
indicator

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

Type:

node
listboxId

id attribute of the listbox element. Also used to derive the id attributes of options.

Type:

string
listboxOpen

Controls the open state of the select's listbox.

Type:

bool
name

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.

Type:

string
onChange

Callback fired when an option is selected.

Type:

func
onClose

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

Type:

func
onListboxOpenChange

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

Type:

func
placeholder

Text to show when there is no selected value.

Type:

node
renderValue

Function that customizes the rendering of the selected value.

Type:

func
size

The size of the component.

Type:

'sm' | 'md' | 'lg' | string
slots

The components used for each slot inside.

Type:

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

Leading adornment for the select.

Type:

node
sx

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

Type:

Array<func | object | bool> | func | object
value

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

Type:

any
variant

The global variant to use.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string
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.

root'div'Required

Global class: .MuiSelect-root

Description: The component that renders the root.

button'button'Required

Global class: .MuiSelect-button

Description: The component that renders the button.

startDecorator'span'Required

Global class: .MuiSelect-startDecorator

Description: The component that renders the start decorator.

endDecorator'span'Required

Global class: .MuiSelect-endDecorator

Description: The component that renders the end decorator.

indicator'span'Required

Global class: .MuiSelect-indicator

Description: The component that renders the indicator.

listbox'ul'Required

Global class: .MuiSelect-listbox

Description: The component that renders the listbox.

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

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.Mui-disabledSTATE

State class applied to the root slot if disabled={true}.

.Mui-expandedSTATE

State class applied to the root slot if listbox open.

.Mui-focusVisibleSTATE

State class applied to the SelectBase root slot if the button is keyboard focused.

.MuiSelect-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiSelect-colorDanger

Class name applied to the root slot if color="danger".

.MuiSelect-colorInfo

Class name applied to the root slot if color="info".

.MuiSelect-colorNeutral

Class name applied to the root slot if color="neutral".

.MuiSelect-colorPrimary

Class name applied to the root slot if color="primary".

.MuiSelect-colorSuccess

Class name applied to the root slot if color="success".

.MuiSelect-colorWarning

Class name applied to the root slot if color="warning".

.MuiSelect-popper

Class name applied to the popper slot.

.MuiSelect-sizeLg

Class name applied to the root slot if size="lg".

.MuiSelect-sizeMd

Class name applied to the root slot if size="md".

.MuiSelect-sizeSm

Class name applied to the root slot if size="sm".

.MuiSelect-variantOutlined

Class name applied to the root slot if variant="outlined".

.MuiSelect-variantPlain

Class name applied to the root slot if variant="plain".

.MuiSelect-variantSoft

Class name applied to the root slot if variant="soft".

.MuiSelect-variantSolid

Class name applied to the root slot if variant="solid".