Pular para o conteúdo

Autocomplete API

Documentação da API para o componente React Autocomplete . Aprenda sobre as propriedades disponíveis e a API CSS.

Importação

import Autocomplete from '@mui/material/Autocomplete';
// ou
import { Autocomplete } from '@mui/material';
Você pode aprender sobre a diferença lendo este guia sobre como minimizar o tamanho do pacote.

Nome do componente

The name MuiAutocomplete can be used when providing default props or style overrides in the theme.

Propriedades

Propriedades do componente nativo também estão disponíveis.

NomeTipoPadrãoDescrição
options*array
Array de opções.
renderInput*func
Render the input.

Signature:
function(params: object) => ReactNode
autoCompleteboolfalse
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.
autoHighlightboolfalse
Se true, a primeira opção é destacada automaticamente.
autoSelectboolfalse
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.
blurOnSelect'mouse'
| 'touch'
| bool
false
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.
ChipPropsobject
Props applied to the Chip element.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
clearIconnode<ClearIcon fontSize="small" />
O ícone para exibir no lugar de um ícone de limpar padrão.
clearOnBlurbool!props.freeSolo
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.
clearOnEscapeboolfalse
Se true, limpa todos os valores quando o usuário pressiona escape e o pop-up é fechado.
clearTextstring'Clear'
Override the default text for the clear icon button.
For localization purposes, you can use the provided translations.
closeTextstring'Close'
Override the default text for the close popup icon button.
For localization purposes, you can use the provided translations.
componentsProps{ clearIndicator?: object, paper?: object, popper?: object, popupIndicator?: object }{}
As propriedades usadas para cada slot dentro.
defaultValueanyprops.multiple ? [] : null
The default input value. Use when the component is not controlled.
disableClearableboolfalse
Se true, a entrada não pode ser limpa.
disableCloseOnSelectboolfalse
Se true, o pop-up não fechará quando um valor é selecionado.
disabledboolfalse
Se true, o componente está desabilitado.
disabledItemsFocusableboolfalse
Se true, permitirá foco em itens desabilitados.
disableListWrapboolfalse
Se true, a caixa de lista em um pop-up não irá envolver o foco.
disablePortalboolfalse
Se true, o conteúdo de Popper estará abaixo da hierarquia DOM do componente pai.
filterOptionsfunc
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.
filterSelectedOptionsboolfalse
Se true, oculta as opções selecionadas da caixa de lista.
forcePopupIcon'auto'
| bool
'auto'
Force the visibility display of the popup icon.
freeSoloboolfalse
Se true, o Autocomplete é um solo livre, o que significa que a entrada do usuário não está vinculada às opções fornecidas.
fullWidthboolfalse
Se true, o input ocupará toda a largura de seu contêiner.
getLimitTagsTextfunc(more) => `+${more}`
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.
getOptionDisabledfunc
Usado para determinar o estado desabilitado para uma determinada opção.

Assinatura:
function (option: T) => boolean
option: A opção de teste.
getOptionLabelfunc(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: T) => string
groupByfunc
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.
handleHomeEndKeysbool!props.freeSolo
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.
idstring
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.
includeInputInListboolfalse
Se true, o destaque pode mover para a entrada.
inputValuestring
O valor de entrada.
isOptionEqualToValuefunc
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.
limitTagsinteger-1
O número máximo de tags que serão visíveis quando não estiver focado. Defina -1 para desativar o limite.
ListboxComponentelementType'ul'
O componente usado para renderizar a caixa de listagem.
ListboxPropsobject
Props aplicadas ao elemento Listbox.
loadingboolfalse
If true, the component is in a loading state.
loadingTextnode'Loading…'
Text to display when in a loading state.
For localization purposes, you can use the provided translations.
multipleboolfalse
Se true, o value deve ser um array e o menu suportará múltiplas seleções.
noOptionsTextnode'No options'
Text to display when there are no options.
For localization purposes, you can use the provided translations.
onChangefunc
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".
onClosefunc
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".
onHighlightChangefunc
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".
onInputChangefunc
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".
onOpenfunc
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.
openboolfalse
Control the popup` open state.
openOnFocusboolfalse
Se true, o pop-up abrirá quando a entrada for focada.
openTextstring'Open'
Override the default text for the open popup icon button.
For localization purposes, you can use the provided translations.
PaperComponentelementTypePaper
O componente usado para renderizar o corpo do pop-up.
PopperComponentelementTypePopper
O componente usado para posicionar o pop-up.
popupIconnode<ArrowDropDownIcon />
The icon to display in place of the default popup icon.
readOnlyboolfalse
If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.
renderGroupfunc
Render the group.

Signature:
function(option: any) => ReactNode
option: The group to render.
renderOptionfunc
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.
renderTagsfunc
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.
selectOnFocusbool!props.freeSolo
If true, the input's text is selected on focus. It helps the user clear the selected value.
size'small'
| 'medium'
| string
'medium'
The size of the autocomplete.
sxArray<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.
valueany
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.

O ref é encaminhado para o elemento raiz.

CSS

Nome da regraClasse globalDescrição
root.MuiAutocomplete-rootEstilos aplicados ao elemento raiz.
fullWidth.MuiAutocomplete-fullWidthEstilos aplicados para o elemento raiz se fullWidth={true}.
focused.Mui-focusedPseudo-class aplicada a o elemento raiz se focused.
tag.MuiAutocomplete-tagEstilos aplicados para os elementos de tag, ex: os chips.
tagSizeSmall.MuiAutocomplete-tagSizeSmallEstilos aplicados para os elementos de tag, e.g. the chips if size="small".
tagSizeMedium.MuiAutocomplete-tagSizeMediumEstilos aplicados para the tag elements, e.g. the chips if size="medium".
hasPopupIcon.MuiAutocomplete-hasPopupIconStyles applied when the popup icon is rendered.
hasClearIcon.MuiAutocomplete-hasClearIconStyles applied when the clear icon is rendered.
inputRoot.MuiAutocomplete-inputRootEstilos aplicados a o elemento Input.
input.MuiAutocomplete-inputEstilos aplicados a o elemento input.
inputFocused.MuiAutocomplete-inputFocusedEstilos aplicados para o elemento input se the input is focused.
endAdornment.MuiAutocomplete-endAdornmentEstilos aplicados a o elemento endAdornment.
clearIndicator.MuiAutocomplete-clearIndicatorEstilos aplicados a o indicador de limpar.
popupIndicator.MuiAutocomplete-popupIndicatorEstilos aplicados a o indicador de pop-up.
popupIndicatorOpen.MuiAutocomplete-popupIndicatorOpenEstilos aplicados para o indicador de pop-up se o pop-up estiver aberto.
popper.MuiAutocomplete-popperEstilos aplicados a o elemento popper.
popperDisablePortal.MuiAutocomplete-popperDisablePortalEstilos aplicados para o elemento popper se disablePortal={true}.
paper.MuiAutocomplete-paperEstilos aplicados a o componente Paper.
listbox.MuiAutocomplete-listboxEstilos aplicados a o componente listbox.
loading.MuiAutocomplete-loadingEstilos aplicados a o wrapper de carregamento.
noOptions.MuiAutocomplete-noOptionsEstilos aplicados a o wrapper de sem opção.
option.MuiAutocomplete-optionEstilos aplicados a os elementos de opção.
groupLabel.MuiAutocomplete-groupLabelEstilos aplicados a os elementos de label dos groupos.
groupUl.MuiAutocomplete-groupUlEstilos aplicados a os elementos de ul dos groupos.

Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:

Demonstrações