Autocomplete API

Array de opções.

Render the input.

Signature:
function(params: object) => ReactNode

Se true, a porção da sugestão selecionada que não foi digitada pelo usuário, conhecida como a sequência de conclusão, aparece embutida após o cursor da entrada na caixa de texto. A sequência de conclusão é visualmente destacada e tem um estado selecionado.

Se true, a primeira opção é destacada automaticamente.

Se true, a opção selecionada se torna o valor de entrada quando o Autocomplete perde o foco, a menos que o usuário escolha uma opção diferente ou mude um caractere da sequência na entrada.

Controle se a entrada deve ficar borrada quando uma opção é selecionada:
- false a entrada não é borrada. - true a entrada sempre é borrada. - touch a entrada é borrada após um evento de toque. - mouse a entrada é borrada após um evento de mouse.

Props applied to the Chip element.

Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.

O ícone para exibir no lugar de um ícone de limpar padrão.

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.

Se true, limpa todos os valores quando o usuário pressiona escape e o pop-up é fechado.

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.

As propriedades usadas para cada slot dentro.

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

Se true, a entrada não pode ser limpa.

Se true, o pop-up não fechará quando um valor é selecionado.

Se true, o componente está desabilitado.

Se true, permitirá foco em itens desabilitados.

Se true, a caixa de lista em um pop-up não irá envolver o foco.

Se true, o conteúdo de Popper estará abaixo da hierarquia DOM do componente pai.

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

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

Se true, oculta as opções selecionadas da caixa de lista.

Force the visibility display of the popup icon.

Se true, o Autocomplete é um solo livre, o que significa que a entrada do usuário não está vinculada às opções fornecidas.

Se true, o input ocupará toda a largura de seu contêiner.

O rótulo a ser exibido quando as tags são truncadas (limitTags).

Assinatura:
function (more: number) => ReactNode
more: O número de tags truncadas.

Usado para determinar o estado desabilitado para uma determinada opção.

Assinatura:
function (option: T) => boolean
option: A opção de teste.

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: T) => string

Se fornecido, as opções serão agrupadas sob a string retornada. O valor groupBy também é usado como o texto para os títulos dos grupos quando renderGroup não é fornecido.

Assinatura:
function (options: T) => string
options: As opções para grupo.

Se true, o componente lida com as teclas "Home" e "End" quando o pop-up estiver aberto. Deverá movimentar-se para a primeira opção e para a última opção, respectivamente.

Esta propriedade é usada para ajudar a implementar a lógica de acessibilidade. Se você não fornecer um ‘id’, ela retornará um ‘id’ gerado aleatoriamente.

Se true, o destaque pode mover para a entrada.

O valor de entrada.

Usado para determinar se a opção representa o valor dado. Usa uma igualdade estrita por padrão. ⚠️ Ambos os argumentos precisam ser manipulados, uma opção só pode corresponder com um valor.

Assinatura:
function (option: T, value: T) => boolean
option: A opção de teste.
value: O valor a ser testado.

O número máximo de tags que serão visíveis quando não estiver focado. Defina -1 para desativar o limite.

O componente usado para renderizar a caixa de listagem.

Props aplicadas ao elemento Listbox.

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.

Se true, o value deve ser um array e o menu suportará múltiplas seleções.

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.

Se true, o pop-up abrirá quando a entrada for focada.

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

O componente usado para renderizar o corpo do pop-up.

O componente usado para posicionar o pop-up.

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

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

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: Array<T>, getTagProps: function, ownerState: object) => ReactNode
value: The value provided to the component.
getTagProps: A tag props getter.
ownerState: The state of the Autocomplete component.

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.