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:

Autocomplete

Import

import Autocomplete from '@mui/joy/Autocomplete';
// or
import { Autocomplete } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

optionsRequired

Array of options.

Type:

array

aria-describedby

Identifies the element (or elements) that describes the object.

Type:

string

aria-label

Defines a string value that labels the current element.

Type:

string

aria-labelledby

Identifies the element (or elements) that labels the current element.

Type:

string

autoFocus

If true, the input element is focused during the first mount.

Type:

bool

clearIcon

The icon to display in place of the default clear icon.

Type:

node

Default:

<ClearIcon fontSize="md" />

clearText

Override the default text for the clear icon button.
For localization purposes, you can use the provided translations.

Type:

string

Default:

'Clear'

closeText

Override the default text for the close popup icon button.
For localization purposes, you can use the provided translations.

Type:

string

Default:

'Close'

color

The color of the component. It supports those theme colors that make sense for this component.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning'

Default:

'neutral'

defaultValue

The default value. Use when the component is not controlled.

Type:

any

Default:

props.multiple ? [] : null

disableClearable

If true, the input can't be cleared.

Type:

bool

Default:

false

disabled

If true, the component is disabled.

Type:

bool

Default:

false

endDecorator

Trailing adornment for this input.

Type:

node

error

If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.

Type:

bool

Default:

false

filterOptions

A function that determines the filtered options to be rendered on search.

Type:

func

Default:

createFilterOptions()

Signature:

function(options: Array, state: object) => Array

options The options to render.
state The state of the component.

forcePopupIcon

Force the visibility display of the popup icon.

Type:

'auto' | bool

Default:

'auto'

freeSolo

If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.

Type:

bool

Default:

false

getLimitTagsText

The label to display when the tags are truncated (limitTags).

Type:

func

Default:

(more: string | number) => `+${more}`

Signature:

function(more: string | number) => ReactNode

more The number of truncated tags.

getOptionDisabled

Used to determine the disabled state for a given option.

Type:

func

Signature:

function(option: T) => boolean

option The option to test.

getOptionLabel

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.

Type:

func

Default:

(option) => option.label ?? option

Signature:

function(option: T) => string

groupBy

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.

Type:

func

Signature:

function(options: T) => string

options The options to group.

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.

Type:

string

inputValue

The input value.

Type:

string

isOptionEqualToValue

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.

Type:

func

Signature:

function(option: T, value: T) => boolean

option The option to test.
value The value to test against.

limitTags

The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.

Type:

integer

Default:

-1

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).

Type:

bool

Default:

false

loadingText

Text to display when in a loading state.
For localization purposes, you can use the provided translations.

Type:

node

Default:

'Loading…'

multiple

If true, value must be an array and the menu will support multiple selections.

Type:

bool

Default:

false

name

Name attribute of the input element.

Type:

string

noOptionsText

Text to display when there are no options.
For localization purposes, you can use the provided translations.

Type:

node

Default:

'No options'

onChange

Callback fired when the value changes.

Type:

func

Signature:

function(event: React.SyntheticEvent, value: T | Array, 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".

onClose

Callback fired when the popup requests to be closed. Use in controlled mode (see open).

Type:

func

Signature:

function(event: React.SyntheticEvent, reason: string) => void

event The event source of the callback.
reason Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".

onHighlightChange

Callback fired when the highlight option changes.

Type:

func

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", "touch".

onInputChange

Callback fired when the input value changes.

Type:

func

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".

onOpen

Callback fired when the popup requests to be opened. Use in controlled mode (see open).

Type:

func

Signature:

function(event: React.SyntheticEvent) => void

event The event source of the callback.

open

If true, the component is shown.

Type:

bool

openText

Override the default text for the open popup icon button.
For localization purposes, you can use the provided translations.

Type:

string

Default:

'Open'

placeholder

The input placeholder

Type:

string

popupIcon

The icon to display in place of the default popup icon.

Type:

node

Default:

<ArrowDropDownIcon />

readOnly

If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.

Type:

bool

Default:

false

renderGroup

Render the group.

Type:

func

Signature:

function(params: AutocompleteRenderGroupParams) => ReactNode

params The group to render.

renderOption

Render the option, use getOptionLabel by default.

Type:

func

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.

renderTags

Render the selected value.

Type:

func

Signature:

function(value: Array, getTagProps: function, ownerState: object) => ReactNode

value The value provided to the component.
getTagProps A tag props getter.
ownerState The state of the Autocomplete component.

required

If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.

Type:

bool

size

The size of the component.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'

slotProps

The props used for each slot inside.

Type:

{ clearIndicator?: func | object, endDecorator?: func | object, input?: func | object, limitTag?: func | object, listbox?: func | object, loading?: func | object, noOptions?: func | object, option?: func | object, popupIndicator?: func | object, root?: func | object, startDecorator?: func | object, wrapper?: func | object }

Default:

{}

slots

The components used for each slot inside.

Type:

{ clearIndicator?: elementType, endDecorator?: elementType, input?: elementType, limitTag?: elementType, listbox?: elementType, loading?: elementType, noOptions?: elementType, option?: elementType, popupIndicator?: elementType, root?: elementType, startDecorator?: elementType, wrapper?: elementType }

Default:

{}

startDecorator

Leading adornment for this input.

Type:

node

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object

type

Type of the input element. It should be a valid HTML5 input type.

Type:

string

value

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.

Type:

any

variant

The global variant to use.

Type:

'outlined' | 'plain' | 'soft' | 'solid'

Default:

'outlined'

The ref is forwarded to the root element.

Theme default props

You can use JoyAutocomplete to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root'div'Required

Global class: .MuiAutocomplete-root

Description: The component that renders the root.

wrapper'div'Required

Global class: .MuiAutocomplete-wrapper

Description: The component that renders the wrapper.

input'input'Required

Global class: .MuiAutocomplete-input

Description: The component that renders the input.

startDecorator'div'Required

Global class: .MuiAutocomplete-startDecorator

Description: The component that renders the start decorator.

endDecorator'div'Required

Global class: .MuiAutocomplete-endDecorator

Description: The component that renders the end decorator.

clearIndicator'button'Required

Global class: .MuiAutocomplete-clearIndicator

Description: The component that renders the clear indicator.

popupIndicator'button'Required

Global class: .MuiAutocomplete-popupIndicator

Description: The component that renders the popup indicator.

listbox'ul'Required

Global class: .MuiAutocomplete-listbox

Description: The component that renders the listbox.

option'li'Required

Global class: .MuiAutocomplete-option

Description: The component that renders the option.

loading'li'Required

Global class: .MuiAutocomplete-loading

Description: The component that renders the loading.

noOptions'li'Required

Global class: .MuiAutocomplete-noOptions

Description: The component that renders the no-options.

limitTag'div'Required

Global class: .MuiAutocomplete-limitTag

Description: The component that renders the limit tag.

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 styleOverrides property in a custom theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.Mui-disabledSTATE

Class name applied to the root element if disabled={true}.

.Mui-errorSTATE

State class applied to the root element if error={true}.

.Mui-focusedSTATE

Class name applied to the root element if the component is focused.

.MuiAutocomplete-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiAutocomplete-colorDanger

Class name applied to the root element if color="danger".

.MuiAutocomplete-colorNeutral

Class name applied to the root element if color="neutral".

.MuiAutocomplete-colorPrimary

Class name applied to the root element if color="primary".

.MuiAutocomplete-colorSuccess

Class name applied to the root element if color="success".

.MuiAutocomplete-colorWarning

Class name applied to the root element if color="warning".

.MuiAutocomplete-formControl

Class name applied to the root element if the component is a descendant of FormControl.

.MuiAutocomplete-hasClearIcon

Class name applied when the clear icon is rendered.

.MuiAutocomplete-hasPopupIcon

Class name applied when the popup icon is rendered.

.MuiAutocomplete-multiple

Class name applied to the wrapper element if multiple={true}.

.MuiAutocomplete-popupIndicatorOpen

Class name applied to the popup indicator if the popup is open.

.MuiAutocomplete-sizeLg

Class name applied to the root element if size="lg".

.MuiAutocomplete-sizeMd

Class name applied to the root element if size="md".

.MuiAutocomplete-sizeSm

Class name applied to the root element if size="sm".

.MuiAutocomplete-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiAutocomplete-variantPlain

Class name applied to the root element if variant="plain".

.MuiAutocomplete-variantSoft

Class name applied to the root element if variant="soft".

.MuiAutocomplete-variantSolid

Class name applied to the root element if variant="solid".

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.