跳转到内容

Select API

API documentation for the React Select component. Learn about the available props, and the CSS API.

Import

import Select from '@mui/material/Select';
// 或
import { Select } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiSelect can be used when providing default props or style overrides in the theme.

属性

Props of the OutlinedInput component are also available.

名称类型默认值描述
autoWidthboolfalse
If true, the width of the popover will automatically be set according to the items inside the menu, otherwise it will be at least the width of the select input.
childrennode
The option elements to populate the select with. Can be some MenuItem when native is false and option when native is true.
⚠️The MenuItem elements must be direct descendants when native is false.
classesobject{}
Override or extend the styles applied to the component. See CSS API below for more details.
defaultValueany
The default input value. Use when the component is not controlled.
displayEmptyboolfalse
If true, a value is displayed even if no items are selected.
In order to display a meaningful value, a function can be passed to the renderValue prop which returns the value to be displayed when no items are selected.
⚠️ When using this prop, make sure the label doesn't overlap with the empty displayed value. The label should either be hidden or forced to a shrunk state.
IconComponentelementTypeArrowDropDownIcon
The icon that displays the arrow.
idstring
The id of the wrapper element or the select element when native.
inputelement
An Input element; does not have to be a material-ui specific Input.
inputPropsobject
Attributes applied to the input element. When native is true, the attributes are applied on the select element.
labelnode
labelIdstring
The ID of an element that acts as an additional label. The Select will be labelled by the additional label and the selected value.
MenuPropsobject
Props applied to the Menu element.
multipleboolfalse
If true, value must be an array and the menu will support multiple selections.
nativeboolfalse
If true, the component uses a native select element.
onChangefunc
Callback fired when a menu item is selected.

Signature:
function(event: object, child?: object) => void
event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
child: The react element that was selected when native is false (default).
onClosefunc
Callback fired when the component requests to be closed. Use in controlled mode (see open).

Signature:
function(event: object) => void
event: The event source of the callback.
onOpenfunc
Callback fired when the component requests to be opened. Use in controlled mode (see open).

Signature:
function(event: object) => void
event: The event source of the callback.
openboolfalse
Control select open state. You can only use it when the native prop is false (default).
renderValuefunc
Render the selected value. You can only use it when the native prop is false (default).

Signature:
function(value: any) => ReactNode
value: The value provided to the component.
SelectDisplayPropsobject
Props applied to the clickable div element.
sxArray<func
| object>
| 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 input value. Providing an empty string will select no options. This prop is required when the native prop is false (default). Set to an empty string '' if you don't want any of the available options to be selected.
If the value is an object it must have reference equality with the option in order to be selected. If the value is not an object, the string representation must match with the string representation of the option in order to be selected.
variant'filled'
| 'outlined'
| 'standard'
'outlined'
The variant to use.

ref 则会被传递到根元素中。

Inheritance

While not explicitly documented above, the props of the OutlinedInput component are also available on Select. You can take advantage of this to target nested components.

CSS

Rule nameGlobal class描述
select.MuiSelect-selectStyles applied to the select component `select` class.
multiple.MuiSelect-multiple
filled.MuiSelect-filledStyles applied to the select component if variant="filled".
outlined.MuiSelect-outlinedStyles applied to the select component if variant="outlined".
standard.MuiSelect-standardStyles applied to the select component if variant="standard".
disabled.Mui-disabledPseudo-class applied to the select component `disabled` class.
icon.MuiSelect-iconStyles applied to the icon component.
iconOpen.MuiSelect-iconOpenStyles applied to the icon component if the popup is open.
iconFilled.MuiSelect-iconFilledStyles applied to the icon component if variant="filled".
iconOutlined.MuiSelect-iconOutlinedStyles applied to the icon component if variant="outlined".
iconStandard.MuiSelect-iconStandardStyles applied to the icon component if variant="standard".
nativeInput.MuiSelect-nativeInputStyles applied to the underlying native input component.

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

Demos