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.

Component demos

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

autoComplete

If true, the portion of the selected suggestion that the user hasn't typed, 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.

Type:bool

Default:false

autoFocus

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

Type:bool

autoHighlight

If true, the first option is automatically highlighted.

Type:bool

Default:false

autoSelect

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.
When using the freeSolo mode, the typed value will be the input value if the Autocomplete loses focus without highlighting an option.

Type:bool

Default:false

blurOnSelect

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.

Type:'mouse'
| 'touch'
| bool

Default:false

clearIcon

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

Type:node

Default:<ClearIcon fontSize="md" />

clearOnBlur

If true, the input's text is cleared on blur if no value is selected.
Set it to true if you want to help the user enter a new value. Set it to false if you want to help the user resume their search.

Type:bool

Default:!props.freeSolo

clearOnEscape

If true, clear all values when the user presses escape and the popup is closed.

Type:bool

Default:false

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.

To learn how to add your own colors, check out Themed components—Extend colors.

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

disableCloseOnSelect

If true, the popup won't close when a value is selected.

Type:bool

Default:false

disabled

If true, the component is disabled.

Type:bool

Default:false

disabledItemsFocusable

If true, will allow focus on disabled items.

Type:bool

Default:false

disableListWrap

If true, the list box in the popup will not wrap focus.

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

If true, hide the selected options from the list box.

Type:bool

Default:false

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: Value) => boolean
  • option The option to test.
getOptionKey

Used to determine the key for a given option. This can be useful when the labels of options are not unique (since labels are used as keys by default).

Type:func

Signature:
function(option: Value) => string | number
  • option The option to get the key for.
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: Value) => 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: Value) => string
    • options The options to group.
    handleHomeEndKeys

    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.

    Type:bool

    Default:!props.freeSolo

    id

    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

    includeInputInList

    If true, the highlight can move to the input.

    Type:bool

    Default:false

    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: Value, value: Value) => 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

    loading

    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: Value | 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: Value, 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

    openOnFocus

    If true, the popup will open on input focus.

    Type:bool

    Default:false

    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

    selectOnFocus

    If true, the input's text is selected on focus. It helps the user clear the selected value.

    Type:bool

    Default:!props.freeSolo

    size

    The size of the component.

    To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

    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.

    See Slots API below for more details.

    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

    sx

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

    See the `sx` page for more details.

    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.

    To learn how to add your own variants, check out Themed components—Extend variants.

    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

    The component that renders the root.

    Class name: .MuiAutocomplete-root

    Default component: 'div'

    wrapper

    The component that renders the wrapper.

    Class name: .MuiAutocomplete-wrapper

    Default component: 'div'

    input

    The component that renders the input.

    Class name: .MuiAutocomplete-input

    Default component: 'input'

    startDecorator

    The component that renders the start decorator.

    Class name: .MuiAutocomplete-startDecorator

    Default component: 'div'

    endDecorator

    The component that renders the end decorator.

    Class name: .MuiAutocomplete-endDecorator

    Default component: 'div'

    clearIndicator

    The component that renders the clear indicator.

    Class name: .MuiAutocomplete-clearIndicator

    Default component: 'button'

    popupIndicator

    The component that renders the popup indicator.

    Class name: .MuiAutocomplete-popupIndicator

    Default component: 'button'

    listbox

    The component that renders the listbox.

    Class name: .MuiAutocomplete-listbox

    Default component: 'ul'

    option

    The component that renders the option.

    Class name: .MuiAutocomplete-option

    Default component: 'li'

    loading

    The component that renders the loading.

    Class name: .MuiAutocomplete-loading

    Default component: 'li'

    noOptions

    The component that renders the no-options.

    Class name: .MuiAutocomplete-noOptions

    Default component: 'li'

    limitTag

    The component that renders the limit tag.

    Class name: .MuiAutocomplete-limitTag

    Default component: 'div'

    CSS classes

    These class names are useful for styling with CSS. They are applied to the component's slots 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.

    Rule name:colorContext

    .MuiAutocomplete-colorDanger

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

    Rule name:colorDanger

    .MuiAutocomplete-colorNeutral

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

    Rule name:colorNeutral

    .MuiAutocomplete-colorPrimary

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

    Rule name:colorPrimary

    .MuiAutocomplete-colorSuccess

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

    Rule name:colorSuccess

    .MuiAutocomplete-colorWarning

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

    Rule name:colorWarning

    .MuiAutocomplete-formControl

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

    Rule name:formControl

    .MuiAutocomplete-hasClearIcon

    Class name applied when the clear icon is rendered.

    Rule name:hasClearIcon

    .MuiAutocomplete-hasPopupIcon

    Class name applied when the popup icon is rendered.

    Rule name:hasPopupIcon

    .MuiAutocomplete-multiple

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

    Rule name:multiple

    .MuiAutocomplete-popupIndicatorOpen

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

    Rule name:popupIndicatorOpen

    .MuiAutocomplete-sizeLg

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

    Rule name:sizeLg

    .MuiAutocomplete-sizeMd

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

    Rule name:sizeMd

    .MuiAutocomplete-sizeSm

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

    Rule name:sizeSm

    .MuiAutocomplete-variantOutlined

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

    Rule name:variantOutlined

    .MuiAutocomplete-variantPlain

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

    Rule name:variantPlain

    .MuiAutocomplete-variantSoft

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

    Rule name:variantSoft

    .MuiAutocomplete-variantSolid

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

    Rule name:variantSolid


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