Skip to content
Design System
GitHub

Autocomplete

v0.23.1Beta

A text field that suggests as you type: filter, arrows, Enter, groups, server search with loading.

API reference

Generated from the types. Every part also takes className.

Autocomplete

optionsrequired
AutocompleteOption[]
value
string
onValueChange
(value: string | undefined) => void
onQueryChange
(query: string) => void
debounce
number = 0Call onQueryChange only once the typing has paused this long (ms). The text box itself never waits; clearing never waits.
filter
boolean = trueFilter options by the typed text. Turn off when the server filters.
loading
boolean
placeholder
stringSame as labels.placeholder, and wins over it.
emptyText
stringSame as labels.empty, and wins over it.
labels
Partial<AutocompleteLabels>The words it says, to translate them.
clearable
boolean = true
showTrigger
boolean = trueA chevron that opens the full list.
size
"sm" | "md" = "md"
disabled
boolean
id
string
aria-label
string