Select API
API reference docs for the React Select component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Select from '@mui/joy/Select';
// or
import { Select } from '@mui/joy';A ref for imperative actions. It currently only supports focusVisible() action.
Type:func
| { current?: { focusVisible: func } }
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.
Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
The component used for the root node. Either a string to use a HTML element or a component.
Type:elementType
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
id attribute of the listbox element. Also used to derive the id attributes of options.
Type:string
If true, selecting multiple values is allowed. This affects the type of the value, defaultValue, and onChange props.
Type:bool
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
Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).
Type:func
The size of the component.
To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
Type:'sm'
| 'md'
| 'lg'
| string
The components used for each slot inside.
See Slots API below for more details.
Type:{ button?: elementType, endDecorator?: elementType, indicator?: elementType, listbox?: elementType, root?: elementType, startDecorator?: elementType }
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
The global variant to use.
To learn how to add your own variants, check out Themed components—Extend variants.
Type:'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
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.
To learn how to customize the slot, check out the Overriding component structure guide.
The component that renders the start decorator.
Class name: .MuiSelect-startDecorator
Default component: 'span'
The component that renders the end decorator.
Class name: .MuiSelect-endDecorator
Default component: 'span'
The component that renders the indicator.
Class name: .MuiSelect-indicator
Default component: 'span'
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
State class applied to the SelectBase root slot if the button is keyboard focused.
Class name applied to the root element when color inversion is triggered.
Rule name:colorContext
Class name applied to the root slot if color="neutral".
Rule name:colorNeutral
Class name applied to the root slot if color="primary".
Rule name:colorPrimary
Class name applied to the root slot if color="success".
Rule name:colorSuccess
Class name applied to the root slot if color="warning".
Rule name:colorWarning
Class name applied to the root slot if variant="outlined".
Rule name:variantOutlined
Class name applied to the root slot if variant="plain".
Rule name:variantPlain
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
styleOverridesproperty in a custom theme.