Skip to content

Autocomplete API

API reference docs for the React Autocomplete component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

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

Component name

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
options*array
Array of options.
renderInput*func
Render the input.

Signature:
function(params: object) => ReactNode
autoCompleteboolfalse
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.
autoHighlightboolfalse
If true, the first option is automatically highlighted.
autoSelectboolfalse
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.
ChipPropsobject
Props applied to the Chip element.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
clearIconnode<ClearIcon fontSize="small" />
The icon to display in place of the default clear icon.
clearOnBlurbool!props.freeSolo
If true, the input's text is 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 their search.
clearOnEscapeboolfalse
If true, clear all values when the user presses escape and the popup is closed.
clearTextstring'Clear'
Override the default text for the clear icon button.
For localization purposes, you can use the provided translations.
closeTextstring'Close'
Override the default text for the close popup icon button.
For localization purposes, you can use the provided translations.
componentsProps{ clearIndicator?: object, paper?: object, popper?: object, popupIndicator?: object }{}
The props used for each slot inside.
defaultValueanyprops.multiple ? [] : null
The default value. Use when the component is not controlled.
disableClearableboolfalse
If true, the input can't be cleared.
disableCloseOnSelectboolfalse
If true, the popup won't close when a value is selected.
disabledboolfalse
If true, the component is disabled.
disabledItemsFocusableboolfalse
If true, will allow focus on disabled items.
disableListWrapboolfalse
If true, the list box in the popup will not wrap focus.
disablePortalboolfalse
If true, the Popper content will be under the DOM hierarchy of the parent component.
filterOptionsfunc
A function that determines the filtered options to be rendered on search.

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

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

Signature:
function(option: T) => boolean
option: The option to test.
getOptionLabelfunc(option) => option.label ?? option
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).
If used in free solo mode, it must accept both the type of the options and a string.

Signature:
function(option: T) => string
groupByfunc
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.
handleHomeEndKeysbool!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.
idstring
This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.
includeInputInListboolfalse
If true, the highlight can move to the input.
inputValuestring
The input value.
isOptionEqualToValuefunc
Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.

Signature:
function(option: T, value: T) => boolean
option: The option to test.
value: The value to test against.
limitTagsinteger-1
The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.
ListboxComponentelementType'ul'
The component used to render the listbox.
ListboxPropsobject
Props applied to the Listbox element.
loadingboolfalse
If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty).
loadingTextnode'Loading…'
Text to display when in a loading state.
For localization purposes, you can use the provided translations.
multipleboolfalse
If true, value must be an array and the menu will support multiple selections.
noOptionsTextnode'No options'
Text to display when there are no options.
For localization purposes, you can use the provided translations.
onChangefunc
Callback fired when the value changes.

Signature:
function(event: React.SyntheticEvent, value: T | Array<T>, reason: string, details?: string) => void
event: The event source of the callback.
value: The new value of the component.
reason: One of "createOption", "selectOption", "removeOption", "blur" or "clear".
onClosefunc
Callback fired when the popup requests to be closed. Use in controlled mode (see open).

Signature:
function(event: React.SyntheticEvent, reason: string) => void
event: The event source of the callback.
reason: Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".
onHighlightChangefunc
Callback fired when the highlight option changes.

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

Signature:
function(event: React.SyntheticEvent, 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".
onOpenfunc
Callback fired when the popup requests to be opened. Use in controlled mode (see open).

Signature:
function(event: React.SyntheticEvent) => void
event: The event source of the callback.
openbool
If true, the component is shown.
openOnFocusboolfalse
If true, the popup will open on input focus.
openTextstring'Open'
Override the default text for the open popup icon button.
For localization purposes, you can use the provided translations.
PaperComponentelementTypePaper
The component used to render the body of the popup.
PopperComponentelementTypePopper
The component used to position the popup.
popupIconnode<ArrowDropDownIcon />
The icon to display in place of the default popup icon.
readOnlyboolfalse
If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.
renderGroupfunc
Render the group.

Signature:
function(params: AutocompleteRenderGroupParams) => ReactNode
params: The group to render.
renderOptionfunc
Render the option, use getOptionLabel by default.

Signature:
function(props: object, option: T, state: object) => ReactNode
props: The props to apply on the li element.
option: The option to render.
state: The state of the component.
renderTagsfunc
Render the selected value.

Signature:
function(value: Array<T>, getTagProps: function, ownerState: object) => ReactNode
value: The value provided to the component.
getTagProps: A tag props getter.
ownerState: The state of the Autocomplete component.
selectOnFocusbool!props.freeSolo
If true, the input's text is selected on focus. It helps the user clear the selected value.
size'small'
| 'medium'
| string
'medium'
The size of the component.
slotProps{ clearIndicator?: object, paper?: object, popper?: object, popupIndicator?: object }{}
The props used for each slot inside.
sxArray<func
| object
| bool>
| 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 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 isOptionEqualToValue prop.

The ref is forwarded to the root element.

CSS

Rule nameGlobal classDescription
root.MuiAutocomplete-rootStyles applied to the root element.
fullWidth.MuiAutocomplete-fullWidthStyles applied to the root element if fullWidth={true}.
focused.Mui-focusedState class applied to the root element if focused.
tag.MuiAutocomplete-tagStyles applied to the tag elements, e.g. the chips.
tagSizeSmall.MuiAutocomplete-tagSizeSmallStyles applied to the tag elements, e.g. the chips if size="small".
tagSizeMedium.MuiAutocomplete-tagSizeMediumStyles applied to the tag elements, e.g. the chips if size="medium".
hasPopupIcon.MuiAutocomplete-hasPopupIconStyles applied when the popup icon is rendered.
hasClearIcon.MuiAutocomplete-hasClearIconStyles applied when the clear icon is rendered.
inputRoot.MuiAutocomplete-inputRootStyles applied to the Input element.
input.MuiAutocomplete-inputStyles applied to the input element.
inputFocused.MuiAutocomplete-inputFocusedStyles applied to the input element if the input is focused.
endAdornment.MuiAutocomplete-endAdornmentStyles applied to the endAdornment element.
clearIndicator.MuiAutocomplete-clearIndicatorStyles applied to the clear indicator.
popupIndicator.MuiAutocomplete-popupIndicatorStyles applied to the popup indicator.
popupIndicatorOpen.MuiAutocomplete-popupIndicatorOpenStyles applied to the popup indicator if the popup is open.
popper.MuiAutocomplete-popperStyles applied to the popper element.
popperDisablePortal.MuiAutocomplete-popperDisablePortalStyles applied to the popper element if disablePortal={true}.
paper.MuiAutocomplete-paperStyles applied to the Paper component.
listbox.MuiAutocomplete-listboxStyles applied to the listbox component.
loading.MuiAutocomplete-loadingStyles applied to the loading wrapper.
noOptions.MuiAutocomplete-noOptionsStyles applied to the no option wrapper.
option.MuiAutocomplete-optionStyles applied to the option elements.
groupLabel.MuiAutocomplete-groupLabelStyles applied to the group's label elements.
groupUl.MuiAutocomplete-groupUlStyles applied to the group's ul elements.

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