跳转到内容

🎉 Material UI v5 is out now! Check out the announcement blog post

Select API

The API documentation of the Select React component. Learn more about the props and the CSS customization points.

Import

import Select from '@material-ui/core/Select';
// or
import { Select } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiSelect name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
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 element 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 should be passed to the renderValue prop which returns the value to be displayed when no items are selected. You can only use it when the native prop is false (default).
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 See OutlinedInput#label
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.
labelWidth number 0 See OutlinedInput#label
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 will be using a native select element.
onChange func Callback function 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).
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) => void
event: 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) => void
event: The event source of the callback.
open bool 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) => ReactNode
value: The value provided to the component.
SelectDisplayProps object Props applied to the clickable div element.
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'
'standard' The variant to use.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (Input).

CSS

Rule name Global class Description
root .MuiSelect-root Styles applied to the select component root class.
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".
selectMenu .MuiSelect-selectMenu Styles applied to the select component selectMenu class.
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".
nativeInput .MuiSelect-nativeInput Styles applied to the underlying native input component.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

The props of the Input component are also available. You can take advantage of this behavior to target nested components.

Demos