Skip to content
Edit this page

Autocomplete API

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

Import

import Autocomplete from '@material-ui/lab/Autocomplete';
// or
import { Autocomplete } from '@material-ui/lab';

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

Component name

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

Props

Name Type Default Description
autoComplete bool false If true, the portion of the selected suggestion that has not been typed by the user, known as the completion string, appears inline after the input cursor in the textbox. The inline completion string is visually highlighted and has a selected state.
autoHighlight bool false If true, the first option is automatically highlighted.
autoSelect bool false If true, the selected option becomes the value of the input when the Autocomplete loses focus unless the user chooses a different option or changes the character string in the input.
blurOnSelect 'mouse'
| 'touch'
| bool		 false Control if the input should be blurred when an option is selected:
- false the input is not blurred. - true the input is always blurred. - touch the input is blurred after a touch event. - mouse the input is blurred after a mouse event.
ChipProps object Props applied to the Chip element.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
clearOnBlur bool !props.freeSolo If true, the input's text will be cleared on blur if no value is selected.
Set to true if you want to help the user enter a new value. Set to false if you want to help the user resume his search.
clearOnEscape bool false If true, clear all values when the user presses escape and the popup is closed.
clearText string 'Clear' Override the default text for the clear icon button.
For localization purposes, you can use the provided translations.
closeIcon node <CloseIcon fontSize="small" /> The icon to display in place of the default close icon.
closeText string 'Close' Override the default text for the close popup icon button.
For localization purposes, you can use the provided translations.
debug bool false If true, the popup will ignore the blur event if the input is filled. You can inspect the popup markup with your browser tools. Consider this option when you need to customize the component.
defaultValue any
| array		 props.multiple ? [] : null The default input value. Use when the component is not controlled.
disableClearable bool false If true, the input can't be cleared.
disableCloseOnSelect bool false If true, the popup won't close when a value is selected.
disabled bool false If true, the input will be disabled.
disabledItemsFocusable bool false If true, will allow focus on disabled items.
disableListWrap bool false If true, the list box in the popup will not wrap focus.
disablePortal bool false Disable the portal behavior. The children stay within it's parent DOM hierarchy.
filterOptions func A filter function that determines the options that are eligible.

Signature:
function(options: T[], state: object) => undefined
options: The options to render.
state: The state of the component.
filterSelectedOptions bool false If true, hide the selected options from the list box.
forcePopupIcon 'auto'
| bool		 'auto' Force the visibility display of the popup icon.
freeSolo bool false If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.
fullWidth bool false If true, the input will take up the full width of its container.
getLimitTagsText func (more) => +${more} The label to display when the tags are truncated (limitTags).

Signature:
function(more: number) => ReactNode
more: The number of truncated tags.
getOptionDisabled func Used to determine the disabled state for a given option.

Signature:
function(option: T) => boolean
option: The option to test.
getOptionLabel func (x) => x Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).

Signature:
function(option: T) => string
getOptionSelected func Used to determine if an option is selected, considering the current value. Uses strict equality by default.

Signature:
function(option: T, value: T) => boolean
option: The option to test.
value: The value to test against.
groupBy func If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.

Signature:
function(options: T) => string
options: The options to group.
handleHomeEndKeys bool !props.freeSolo If true, the component handles the "Home" and "End" keys when the popup is open. It should move focus to the first option and last option, respectively.
id string This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.
includeInputInList bool false If true, the highlight can move to the input.
inputValue string The input value.
limitTags number -1 The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.
ListboxComponent elementType 'ul' The component used to render the listbox.
ListboxProps object Props applied to the Listbox element.
loading bool false If true, the component is in a loading state.
loadingText node 'Loading…' Text to display when in a loading state.
For localization purposes, you can use the provided translations.
multiple bool false If true, value must be an array and the menu will support multiple selections.
noOptionsText node 'No options' Text to display when there are no options.
For localization purposes, you can use the provided translations.
onChange func Callback fired when the value changes.

Signature:
function(event: object, value: T, reason: string) => void
event: The event source of the callback.
value: The new value of the component.
reason: One of "create-option", "select-option", "remove-option", "blur" or "clear".
onClose func Callback fired when the popup requests to be closed. Use in controlled mode (see open).

Signature:
function(event: object, reason: string) => void
event: The event source of the callback.
reason: Can be: "toggleInput", "escape", "select-option", "blur".
onHighlightChange func Callback fired when the highlight option changes.

Signature:
function(event: object, option: T, reason: string) => void
event: The event source of the callback.
option: The highlighted option.
reason: Can be: "keyboard", "auto", "mouse".
onInputChange func Callback fired when the input value changes.

Signature:
function(event: object, value: string, reason: string) => void
event: The event source of the callback.
value: The new value of the text input.
reason: Can be: "input" (user input), "reset" (programmatic change), "clear".
onOpen func Callback fired when the popup 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 the popup` open state.
openOnFocus bool false If true, the popup will open on input focus.
openText string 'Open' Override the default text for the open popup icon button.
For localization purposes, you can use the provided translations.
options * array Array of options.
PaperComponent elementType Paper The component used to render the body of the popup.
PopperComponent elementType Popper The component used to position the popup.
popupIcon node <ArrowDropDownIcon /> The icon to display in place of the default popup icon.
renderGroup func Render the group.

Signature:
function(option: any) => ReactNode
option: The group to render.
renderInput * func Render the input.

Signature:
function(params: object) => ReactNode
renderOption func Render the option, use getOptionLabel by default.

Signature:
function(option: T, state: object) => ReactNode
option: The option to render.
state: The state of the component.
renderTags func Render the selected value.

Signature:
function(value: T[], getTagProps: function) => ReactNode
value: The value provided to the component.
getTagProps: A tag props getter.
selectOnFocus bool !props.freeSolo If true, the input's text will be selected on focus. It helps the user clear the selected value.
size 'medium'
| 'small'		 'medium' The size of the autocomplete.
value any
| array		 The value of the autocomplete.
The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the getOptionSelected prop.

The ref is forwarded to the root element.

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

CSS

Rule name Global class Description
root .MuiAutocomplete-root Styles applied to the root element.
fullWidth .MuiAutocomplete-fullWidth Styles applied to the root element if fullWidth={true}.
focused .Mui-focused Pseudo-class applied to the root element if focused.
tag .MuiAutocomplete-tag Styles applied to the tag elements, e.g. the chips.
tagSizeSmall .MuiAutocomplete-tagSizeSmall Styles applied to the tag elements, e.g. the chips if size="small".
hasPopupIcon .MuiAutocomplete-hasPopupIcon Styles applied when the popup icon is rendered.
hasClearIcon .MuiAutocomplete-hasClearIcon Styles applied when the clear icon is rendered.
inputRoot .MuiAutocomplete-inputRoot Styles applied to the Input element.
input .MuiAutocomplete-input Styles applied to the input element.
inputFocused .MuiAutocomplete-inputFocused Styles applied to the input element if tag focused.
endAdornment .MuiAutocomplete-endAdornment Styles applied to the endAdornment element.
clearIndicator .MuiAutocomplete-clearIndicator Styles applied to the clear indicator.
clearIndicatorDirty .MuiAutocomplete-clearIndicatorDirty Styles applied to the clear indicator if the input is dirty.
popupIndicator .MuiAutocomplete-popupIndicator Styles applied to the popup indicator.
popupIndicatorOpen .MuiAutocomplete-popupIndicatorOpen Styles applied to the popup indicator if the popup is open.
popper .MuiAutocomplete-popper Styles applied to the popper element.
popperDisablePortal .MuiAutocomplete-popperDisablePortal Styles applied to the popper element if disablePortal={true}.
paper .MuiAutocomplete-paper Styles applied to the Paper component.
listbox .MuiAutocomplete-listbox Styles applied to the listbox component.
loading .MuiAutocomplete-loading Styles applied to the loading wrapper.
noOptions .MuiAutocomplete-noOptions Styles applied to the no option wrapper.
option .MuiAutocomplete-option Styles applied to the option elements.
groupLabel .MuiAutocomplete-groupLabel Styles applied to the group's label elements.
groupUl .MuiAutocomplete-groupUl Styles applied to the group's ul elements.

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.

Demos