OptionalaboutOptionalaccessOptionalaria-Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optionalaria-Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
Optionalaria-Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
Optionalaria-Defines a string value that labels the current element, which is intended to be converted into Braille.
Optionalaria-Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
Optionalaria-Optionalaria-Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
Optionalaria-Defines the total number of columns in a table, grid, or treegrid.
Optionalaria-Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-colindex.
Optionalaria-Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Identifies the element (or elements) whose contents or presence are controlled by the current element.
Optionalaria-Indicates the element that represents the current item within a container or set of related elements.
Optionalaria-Identifies the element (or elements) that describes the object.
Optionalaria-Defines a string value that describes or annotates the current element.
Optionalaria-Identifies the element that provides a detailed, extended description for the object.
Optionalaria-Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Optionalaria-Indicates what functions can be performed when a dragged object is released on the drop target.
Optionalaria-Identifies the element that provides an error message for the object.
Optionalaria-Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optionalaria-Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
Optionalaria-Indicates an element's "grabbed" state in a drag-and-drop operation.
Optionalaria-Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Optionalaria-Indicates whether the element is exposed to an accessibility API.
Optionalaria-Indicates the entered value does not conform to the format expected by the application.
Optionalaria-Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optionalaria-Defines a string value that labels the current element.
Optionalaria-Identifies the element (or elements) that labels the current element.
Optionalaria-Defines the hierarchical level of an element within a structure.
Optionalaria-Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
Optionalaria-Indicates whether an element is modal when displayed.
Optionalaria-Indicates whether a text box accepts multiple lines of input or only a single line.
Optionalaria-Indicates that the user may select more than one item from the current selectable descendants.
Optionalaria-Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optionalaria-Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
Optionalaria-Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
Optionalaria-Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
Optionalaria-Indicates the current "pressed" state of toggle buttons.
Optionalaria-Indicates that the element is not editable, but is otherwise operable.
Optionalaria-Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Optionalaria-Indicates that user input is required on the element before a form may be submitted.
Optionalaria-Defines a human-readable, author-localized description for the role of an element.
Optionalaria-Defines the total number of rows in a table, grid, or treegrid.
Optionalaria-Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-rowindex.
Optionalaria-Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Indicates the current "selected" state of various widgets.
Optionalaria-Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
Optionalaria-Indicates if items in a table or grid are sorted in ascending or descending order.
Optionalaria-Defines the maximum allowed value for a range widget.
Optionalaria-Defines the minimum allowed value for a range widget.
Optionalaria-Defines the current value for a range widget.
Optionalaria-Defines the human readable text alternative of aria-valuenow for a range widget.
OptionalautoOptionalautoIf 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.
OptionalautoOptionalautoOptionalautoIf true, the first option is automatically highlighted.
OptionalautoOptionalautoIf 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.
OptionalblurControl 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.OptionalChipProps applied to the Chip element.
Use slotProps.chip instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalclassesOverride or extend the styles applied to the component.
OptionalclassOptionalclearThe icon to display in place of the default clear icon.
OptionalclearIf 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.
OptionalclearIf true, clear all values when the user presses escape and the popup is closed.
OptionalclearOverride the default text for the clear icon button.
For localization purposes, you can use the provided translations.
OptionalcloseOverride the default text for the close popup icon button.
For localization purposes, you can use the provided translations.
OptionalcolorOptionalcomponentThe component name that is using this hook. Used for warnings.
OptionalcomponentsThe props used for each slot inside.
Use the slotProps prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalcontentOptionalcontentOptionalcontextOptionaldangerouslyOptionaldatatypeOptionaldefaultOptionaldefaultThe default value. Use when the component is not controlled.
OptionaldirOptionaldisableIf true, the input can't be cleared.
OptionaldisableIf true, the popup won't close when a value is selected.
OptionaldisabledIf true, the component is disabled.
OptionaldisabledIf true, will allow focus on disabled items.
OptionaldisableIf true, the list box in the popup will not wrap focus.
OptionaldisableIf true, the Popper content will be under the DOM hierarchy of the parent component.
OptionaldraggableOptionalenterOptionalexportpartsOptionalfilterA function that determines the filtered options to be rendered on search.
OptionalfilterIf true, hide the selected options from the list box.
OptionalforceForce the visibility display of the popup icon.
OptionalfreeIf true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.
If true, the input will take up the full width of its container.
OptionalgetThe label to display when the tags are truncated (limitTags).
The number of truncated tags.
OptionalgetUsed to determine the disabled state for a given option.
OptionalgetUsed 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).
OptionalgetUsed 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.
OptionalgroupIf 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.
OptionalhandleIf 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.
OptionalhiddenOptionalidThis 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.
OptionalincludeIf true, the highlight can move to the input.
OptionalinlistOptionalinputHints at the type of data that might be entered by the user while editing the element or its contents
OptionalinputThe input value.
OptionalisSpecify that a standard HTML element should behave like a defined custom built-in element
OptionalisUsed 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.
OptionalitemOptionalitemOptionalitemOptionalitemOptionalitemOptionallangOptionallimitThe maximum number of tags that will be visible when not focused.
Set -1 to disable the limit.
OptionalListboxThe component used to render the listbox.
Use slotProps.listbox.component instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalListboxProps applied to the Listbox element.
Use slotProps.listbox instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalloadingIf 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).
OptionalloadingText to display when in a loading state.
For localization purposes, you can use the provided translations.
OptionalmultipleIf true, value must be an array and the menu will support multiple selections.
OptionalnonceOptionalnoText to display when there are no options.
For localization purposes, you can use the provided translations.
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonCallback fired when the value changes.
The event source of the callback.
The new value of the component.
One of "createOption", "selectOption", "removeOption", "blur" or "clear".
Optionaldetails: AutocompleteChangeDetails<T>OptionalonOptionalonOptionalonOptionalonCallback fired when the popup requests to be closed. Use in controlled mode (see open).
The event source of the callback.
Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonCallback fired when the highlight option changes.
OptionalonOptionalonOptionalonCallback fired when the input value changes.
The event source of the callback.
The new value of the text input.
Can be: "input" (user input), "reset" (programmatic change), "clear", "blur", "selectOption", "removeOption"
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonCallback fired when the popup requests to be opened. Use in controlled mode (see open).
The event source of the callback.
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalopenIf true, the component is shown.
OptionalopenIf true, the popup will open on input focus.
OptionalopenOverride the default text for the open popup icon button.
For localization purposes, you can use the provided translations.
A list of options that will be shown in the Autocomplete.
OptionalPaperThe component used to render the body of the popup.
Use slots.paper instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalpartOptionalPopperThe component used to position the popup.
Use slots.popper instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalpopupThe icon to display in place of the default popup icon.
OptionalprefixOptionalpropertyOptionalradioOptionalreadIf true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.
OptionalrefOptionalrelOptionalrenderRender the group.
The group to render.
Render the input.
Note: The renderInput prop must return a TextField component or a compatible custom component
that correctly forwards InputProps.ref and spreads inputProps. This ensures proper integration
with the Autocomplete's internal logic (e.g., focus management and keyboard navigation).
Avoid using components like DatePicker or Select directly, as they may not forward the required props,
leading to runtime errors or unexpected behavior.
OptionalrenderRender the option, use getOptionLabel by default.
The props to apply on the li element.
The option to render.
The state of each option.
The state of the Autocomplete component.
OptionalrenderRender the selected value when doing multiple selections.
The value provided to the component.
A tag props getter.
The state of the Autocomplete component.
OptionalrenderRenders the selected value(s) as rich content in the input for both single and multiple selections.
OptionalresourceOptionalresultsOptionalrevOptionalroleOptionalsecurityOptionalselectIf true, the input's text is selected on focus.
It helps the user clear the selected value.
OptionalsizeThe size of the component.
OptionalslotOptionalslotThe props used for each slot inside.
Optionalchip?: SlotProps<OptionalclearIndicator?: SlotProps<Optionallistbox?: SlotProps<Props applied to the Listbox element.
Optionalpaper?: SlotProps<Optionalpopper?: SlotProps<OptionalpopupIndicator?: SlotProps<OptionalslotsThe components used for each slot inside.
OptionalspellOptionalstyleOptionalsuppressOptionalsuppressOptionalsxThe system prop that allows defining system overrides as well as additional CSS styles.
OptionaltabOptionaltitleOptionaltranslateOptionaltypeofOptionalunselectableOptional Internalunstable_The prefix of the state class name, temporary for Joy UI
Optional Internalunstable_Temporary for Joy UI because the parent listbox is the document object TODO v6: Normalize the logic and remove this param.
OptionalvalueThe 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.
Optionalvocab
Properties for the Autocomplete component extending Material-UI's AutocompleteProps