Combobox API
A headless autocomplete input that filters options as the user types, with client and server-side filtering support.
Related
Explore these related pages for additional context and usage patterns.
| Page | Category |
|---|---|
| Combobox | Forms |
| createCombobox | Forms |
| createSelection | Selection |
| useVirtualFocus | System |
| Popover | Disclosure |
| Select | Forms |
Combobox.Root
Props
mandatory
boolean | undefinedControls mandatory selection behavior: - false (default): No mandatory selection enforcement - true: Prevents deselecting the last selected item
Default: false
strict
boolean | undefinedConstrains accepted values to registered options. - false (default): confirming (Enter/Tab) typed text with no match commits it as a new value - true: unmatched text is discarded on confirm; only registered options can be selected
Default: false
error
boolean | undefinedManual error state override — forces invalid regardless of error messages
Default: false
displayValue
((value: unknown) => string) | undefinedMaps selected value to input display text. Defaults to String(value).
modelValue
T | T[] | undefinedEvents
update:model-value
[value: T | T[]]Slots
default
ComboboxRootSlotPropsCombobox.Activator
Props
Slots
default
ComboboxActivatorSlotPropsCombobox.Content
Props
Slots
default
ComboboxContentSlotPropsCombobox.Control
Props
Slots
default
ComboboxControlSlotPropsCombobox.Cue
Props
Slots
default
ComboboxCueSlotPropsCombobox.Description
Props
Slots
default
ComboboxDescriptionSlotPropsCombobox.Empty
Props
Slots
default
ComboboxEmptySlotPropsCombobox.Error
Props
Slots
default
ComboboxErrorSlotPropsCombobox.HiddenInput
Props
Combobox.Item
Props
Slots
default
ComboboxItemSlotProps<V>