Storybook
SketchExamples
Loading
Code
React
Note that any undocumented props that you pass to this component will be passed to the select element, so you can use this to set additional attributes if necessary.
| Name | Type | Default | Description |
|---|---|---|---|
ariaLabel | string | Adds aria-label attribute. When using aria-label, label should be empty string. | |
children | ReactNode | Used to define custom dropdown options (i.e. option groups). When using the children prop, options should be an empty list. | |
defaultValue | DropdownDefaultValue | Sets the initial selected state. Use this for an uncontrolled component;
otherwise, use the value property. | |
disabled | boolean | Disables the entire field. | |
fieldClassName | string | Additional classes to be added to the select element | |
autoFocus | boolean | Sets the focus on the select during the first mount | |
id | string | A unique ID to be used for the select element. If one isn't provided, a unique ID will be generated. /**
Additional hint text to display | |
inputRef | (...args: any[]) => any | Access a reference to the select element | |
inversed | boolean | Applies the "inverse" UI theme | |
namerequired | string | The field's name attribute | |
optionsrequired | DropdownOptions[] | The list of options to be rendered. Provide an empty list if using custom options via the children prop. | |
onBlur | (...args: any[]) => any | ||
onChange | (...args: any[]) => any | ||
requirementLabel | ReactNode | Text showing the requirement ("Required", "Optional", etc.). See Required and Optional Fields. | |
size | DropdownSize | Sets the max-width of the input either to 'small' or 'medium'. | |
value | DropdownValue | Sets the field's value. Use this in combination with onChange
for a controlled component; otherwise, set defaultValue. | |
className | string | Additional classes to be added to the root element. | |
labelrequired | ReactNode | Label for the field. | |
labelId | string | A unique id to be used on the field label. If one isn't provided, a unique ID
will be generated. | |
errorMessage | ReactNode | Enable the error state by providing an error message. | |
errorMessageClassName | string | Additional classes to be added to the error message | |
errorId | string | The ID of the error message applied to this field. | |
hint | ReactNode | Additional hint text to display | |
textClassName | string | Additional classes to be added to the label text. | |
errorPlacement | "top" | "bottom" | Location of the error message relative to the field input | |
labelClassName | string | Additional classes to be added to the field label |
Styles
The following CSS variables can be overridden to customize Dropdown components:
Text Input Options
This component also makes use of some text input styles, which can be customized by the following variables:
Guidance
When to use
- Use sparingly. Use the dropdown component only when a user needs to choose from about seven to 15 possible options and you have limited space to display the options.
When to consider alternatives
- Fewer than seven options. Use radio buttons or checkboxes instead.
- More than 15 options. If the list of options is very long. Let users type the same information into a text input that suggests possible options instead.
- Multi-select. If you need to allow users to select more than one option at once. Users often don’t understand how to select multiple items from dropdowns. Use checkboxes instead.
- Site navigation. Use the navigation components instead.
Usage
- Make sure to test. Test dropdowns thoroughly with members of your target audience. Several usability experts suggest they should be the “UI of last resort.” Many users find them confusing and difficult to use.
- Avoid dependent options. Avoid making options in one dropdown menu change based on the input to another. Users often don’t understand how selecting an item in one impacts another.
- Use a good default. When most users will (or should) pick a particular option, make it the selected default. If a good default is not an option, use a descriptive placeholder like
- Select a state -as the selected default. - Avoid auto-submission. Don’t use JavaScript to automatically submit the form (or do anything else) when an option is selected. Auto-submission disrupts screen readers because they select each option as they read them.
View the "Forms" guidelines for additional guidance and best practices.
Accessibility
- Customize accessibly. If you customize the dropdown, ensure it continues to meet the the accessibility requirements that apply to all form controls.
- Always use a label. Make sure your dropdown has a label. Don’t replace it with the default menu option (for example, removing the “State” label and just having the dropdown read “Select a state” by default).
- Avoid auto-submission. Don’t use JavaScript to automatically submit the form (or do anything else) when an option is selected. Auto-submission disrupts screen readers because they select each option as they read them.
Related patterns
Learn more
- [Form Guidelines]/guidelines/forms/)
- Asking for a date of birth
- Four steps for choosing form elements on the Web (PDF)
- Dropdowns: Design Guidelines
Component maturity
For more information about how we tested and validated our work for each checklist item, read our component maturity documentation.