Autocomplete API

Array of options.

Render the input.

Signature:
function(params: object) => ReactNode

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.

If true, the first option is automatically highlighted.

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.

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.

Props applied to the Chip element.

Override or extend the styles applied to the component. See CSS API below for more details.

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

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 his search.

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

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

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

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

If true, the input can't be cleared.

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

如果被设置为 true，那么该组件将会被禁用。

If true, will allow focus on disabled items.

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

If true, the Popper content will be under the DOM hierarchy of the parent component.

A filter function that determines the options that are eligible.

Signature:
function(options: T[], state: object) => T[]
options: The options to render.
state: The state of the component.

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

Force the visibility display of the popup icon.

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

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

Signature:
function(more: number) => ReactNode
more: The number of truncated tags.

Used to determine the disabled state for a given option.

Signature:
function(option: T) => boolean
option: The option to test.

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

Signature:
function(option: T) => string

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.

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.

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.

If true, the highlight can move to the input.

The input value.

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.

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

The component used to render the listbox.

Props applied to the Listbox element.

If true, the component is in a loading state.

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

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

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

Callback fired when the value changes.

Signature:
function(event: object, value: T | 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".

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

Signature:
function(event: object, reason: string) => void
event: The event source of the callback.
reason: Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".

Callback fired when the highlight option changes.

Signature:
function(event: object, option: T, reason: string) => void
event: The event source of the callback.
option: The highlighted option.
reason: Can be: "keyboard", "auto", "mouse".

Callback fired when the input value changes.

Signature:
function(event: object, 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".

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

Signature:
function(event: object) => void
event: The event source of the callback.

Control the popup` open state.

If true, the popup will open on input focus.

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

The component used to render the body of the popup.

The component used to position the popup.

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

Render the group.

Signature:
function(option: any) => ReactNode
option: The group to render.

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.

Render the selected value.

Signature:
function(value: T[], getTagProps: function) => ReactNode
value: The value provided to the component.
getTagProps: A tag props getter.

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

The size of the autocomplete.

The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

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.