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';Component name
The nameMuiSelect can be used when providing default props or style overrides in the theme.属性
Props of the OutlinedInput component are also available.
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| autoWidth | bool | false | 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. |
| children | node | 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. | |
| classes | object | {} | Override or extend the styles applied to the component. See CSS API below for more details. |
| defaultValue | any | The default input value. Use when the component is not controlled. | |
| displayEmpty | bool | false | 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. |
| IconComponent | elementType | ArrowDropDownIcon | The icon that displays the arrow. |
| id | string | The id of the wrapper element or the select element when native. | |
| input | element | An Input element; does not have to be a material-ui specific Input. | |
| inputProps | object | Attributes applied to the input element. When native is true, the attributes are applied on the select element. | |
| label | node | ||
| labelId | string | The ID of an element that acts as an additional label. The Select will be labelled by the additional label and the selected value. | |
| MenuProps | object | Props applied to the Menu element. | |
| multiple | bool | false | If true, value must be an array and the menu will support multiple selections. |
| native | bool | false | If true, the component uses a native select element. |
| onChange | func | Callback fired when a menu item is selected. Signature: function(event: object, child?: object) => voidevent: 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). | |
| onClose | func | Callback fired when the component requests to be closed. Use in controlled mode (see open). Signature: function(event: object) => voidevent: The event source of the callback. | |
| onOpen | func | Callback fired when the component requests to be opened. Use in controlled mode (see open). Signature: function(event: object) => voidevent: The event source of the callback. | |
| open | bool | false | Control select open state. You can only use it when the native prop is false (default). |
| renderValue | func | Render the selected value. You can only use it when the native prop is false (default).Signature: function(value: any) => ReactNodevalue: The value provided to the component. | |
| SelectDisplayProps | object | Props applied to the clickable div element. | |
| sx | 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 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 name | Global class | 描述 |
|---|---|---|
| root | .MuiSelect-root | Styles applied to the root element. |
| select | .MuiSelect-select | Styles applied to the select component `select` class. |
| filled | .MuiSelect-filled | Styles applied to the select component if variant="filled". |
| outlined | .MuiSelect-outlined | Styles applied to the select component if variant="outlined". |
| standard | .MuiSelect-standard | Styles applied to the select component if variant="standard". |
| disabled | .Mui-disabled | Pseudo-class applied to the select component `disabled` class. |
| icon | .MuiSelect-icon | Styles applied to the icon component. |
| iconOpen | .MuiSelect-iconOpen | Styles applied to the icon component if the popup is open. |
| iconFilled | .MuiSelect-iconFilled | Styles applied to the icon component if variant="filled". |
| iconOutlined | .MuiSelect-iconOutlined | Styles applied to the icon component if variant="outlined". |
| iconStandard | .MuiSelect-iconStandard | Styles applied to the icon component if variant="standard". |
| nativeInput | .MuiSelect-nativeInput | Styles applied to the underlying native input component. |
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.