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.

Name	Type	Default	Description
options*	array	-	Array of options.
aria-describedby	string	-	Identifies the element (or elements) that describes the object.
aria-label	string	-	Defines a string value that labels the current element.
aria-labelledby	string	-	Identifies the element (or elements) that labels the current element.
autoComplete	bool	false	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.
autoFocus	bool	-	If `true`, the `input` element is focused during the first mount.
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. When using the `freeSolo` mode, the typed value will be the input value if the Autocomplete loses focus without highlighting an option.
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.
clearIcon	node	<ClearIcon fontSize="md" />	The icon to display in place of the default clear icon.
clearOnBlur	bool	!props.freeSolo	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.
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.
closeText	string	'Close'	Override the default text for the close popup icon button. For localization purposes, you can use the provided translations.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning'	'neutral'	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.
defaultValue	any	props.multiple ? [] : null	The default 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 component is 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.
endDecorator	node	-	Trailing adornment for this input.
error	bool	false	If `true`, the `input` will indicate an error. The prop defaults to the value (`false`) inherited from the parent FormControl component.
filterOptions	func	createFilterOptions()	A function that determines the filtered options to be rendered on search. Signature:`function(options: Array, state: object) => Array` `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.
getLimitTagsText	func	(more: string \| number) => `+${more}`	The label to display when the tags are truncated (`limitTags`). Signature:`function(more: string \| number) => ReactNode` `more` The number of truncated tags.
getOptionDisabled	func	-	Used to determine the disabled state for a given option. Signature:`function(option: Value) => boolean` `option` The option to test.
getOptionKey	func	-	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). Signature:`function(option: Value) => string \| number` `option` The option to get the key for.
getOptionLabel	func	(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: Value) => string`
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: Value) => 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 an id it will fall back to a randomly generated one.
includeInputInList	bool	false	If `true`, the highlight can move to the input.
inputValue	string	-	The input value.
isOptionEqualToValue	func	-	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: Value, value: Value) => boolean` `option` The option to test. `value` The value to test against.
limitTags	integer	-1	The maximum number of tags that will be visible when not focused. Set `-1` to disable the limit.
loading	bool	false	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, for example `options` are empty).
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.
name	string	-	Name attribute of the `input` element.
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: 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	func	-	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"`.
onHighlightChange	func	-	Callback fired when the highlight option changes. 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	func	-	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"`.
onOpen	func	-	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.
open	bool	-	If `true`, the component is shown.
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.
placeholder	string	-	The input placeholder
popupIcon	node	<ArrowDropDownIcon />	The icon to display in place of the default popup icon.
readOnly	bool	false	If `true`, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.
renderGroup	func	-	Render the group. Signature:`function(params: AutocompleteRenderGroupParams) => ReactNode` `params` The group to render.
renderOption	func	-	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.
renderTags	func	-	Render the selected value. 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	bool	-	If `true`, the `input` element is required. The prop defaults to the value (`false`) inherited from the parent FormControl component.
selectOnFocus	bool	!props.freeSolo	If `true`, the input's text is selected on focus. It helps the user clear the selected value.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ 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 }	{}	The props used for each slot inside.
slots	{ clearIndicator?: elementType, endDecorator?: elementType, input?: elementType, limitTag?: elementType, listbox?: elementType, loading?: elementType, noOptions?: elementType, option?: elementType, popupIndicator?: elementType, root?: elementType, startDecorator?: elementType, wrapper?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
startDecorator	node	-	Leading adornment for this input.
sx	Array<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.
type	string	-	Type of the `input` element. It should be a valid HTML5 input type.
value	any	-	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.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid'	'outlined'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

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.

Slot name	Class name	Default component	Description
root	.MuiAutocomplete-root	`'div'`	The component that renders the root.
wrapper	.MuiAutocomplete-wrapper	`'div'`	The component that renders the wrapper.
input	.MuiAutocomplete-input	`'input'`	The component that renders the input.
startDecorator	.MuiAutocomplete-startDecorator	`'div'`	The component that renders the start decorator.
endDecorator	.MuiAutocomplete-endDecorator	`'div'`	The component that renders the end decorator.
clearIndicator	.MuiAutocomplete-clearIndicator	`'button'`	The component that renders the clear indicator.
popupIndicator	.MuiAutocomplete-popupIndicator	`'button'`	The component that renders the popup indicator.
listbox	.MuiAutocomplete-listbox	`'ul'`	The component that renders the listbox.
option	.MuiAutocomplete-option	`'li'`	The component that renders the option.
loading	.MuiAutocomplete-loading	`'li'`	The component that renders the loading.
noOptions	.MuiAutocomplete-noOptions	`'li'`	The component that renders the no-options.
limitTag	.MuiAutocomplete-limitTag	`'div'`	The component that renders the limit tag.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-disabled		Class name applied to the root element if `disabled={true}`.
.Mui-error		State class applied to the root element if `error={true}`.
.Mui-focused		Class name applied to the root element if the component is focused.
.MuiAutocomplete-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiAutocomplete-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiAutocomplete-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiAutocomplete-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiAutocomplete-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiAutocomplete-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiAutocomplete-formControl	formControl	Class name applied to the root element if the component is a descendant of `FormControl`.
.MuiAutocomplete-hasClearIcon	hasClearIcon	Class name applied when the clear icon is rendered.
.MuiAutocomplete-hasPopupIcon	hasPopupIcon	Class name applied when the popup icon is rendered.
.MuiAutocomplete-multiple	multiple	Class name applied to the wrapper element if `multiple={true}`.
.MuiAutocomplete-popupIndicatorOpen	popupIndicatorOpen	Class name applied to the popup indicator if the popup is open.
.MuiAutocomplete-sizeLg	sizeLg	Class name applied to the root element if `size="lg"`.
.MuiAutocomplete-sizeMd	sizeMd	Class name applied to the root element if `size="md"`.
.MuiAutocomplete-sizeSm	sizeSm	Class name applied to the root element if `size="sm"`.
.MuiAutocomplete-variantOutlined	variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiAutocomplete-variantPlain	variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiAutocomplete-variantSoft	variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiAutocomplete-variantSolid	variantSolid	Class name applied to the root element if `variant="solid"`.

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.