Components
Combobox

Combobox

An intelligent input box with a dropdown for suggesting possible options.

API Reference

Root

PropTypeDefault
items
T[] | readonly T[]
allowCustomValue
boolean
asChild
boolean
autoFocus
boolean
closeOnSelect
boolean
defaultValue
string[]
dir
'ltr' | 'rtl'
"ltr"
disabled
boolean
form
string
getRootNode
() => ShadowRoot | Node | Document
highlightedValue
string
id
string
ids
Partial<{ root: string label: string control: string input: string content: string trigger: string clearTrigger: string item(id: string, index?: number | undefined): string positioner: string itemGroup(id: string | number): string itemGroupLabel(id: string | number): string }>
inputBehavior
'none' | 'autohighlight' | 'autocomplete'
inputValue
string
invalid
boolean
isItemDisabled
(item: T) => boolean
itemToString
(item: T) => string
itemToValue
(item: T) => string
loop
boolean
multiple
boolean
name
string
onFocusOutside
(event: FocusOutsideEvent) => void
onHighlightChange
(details: HighlightChangeDetails<T>) => void
onInputValueChange
(details: InputValueChangeDetails) => void
onInteractOutside
(event: InteractOutsideEvent) => void
onOpenChange
(details: OpenChangeDetails) => void
onPointerDownOutside
(event: PointerDownOutsideEvent) => void
onValueChange
(details: ValueChangeDetails<T>) => void
openOnClick
boolean
placeholder
string
positioning
PositioningOptions
readOnly
boolean
selectionBehavior
'replace' | 'clear' | 'preserve'
selectOnBlur
boolean
translations
IntlTranslations
value
string[]

Item

PropTypeDefault
asChild
boolean
item
any

Input

PropTypeDefault
asChild
boolean

Label

PropTypeDefault
asChild
boolean

Content

PropTypeDefault
asChild
boolean
lazyMount
boolean
false
onExitComplete
() => void
present
boolean
unmountOnExit
boolean
false

Control

PropTypeDefault
asChild
boolean

Trigger

PropTypeDefault
asChild
boolean

ItemText

PropTypeDefault
asChild
boolean

ItemGroup

PropTypeDefault
id
string
asChild
boolean

Positioner

PropTypeDefault
asChild
boolean

ClearTrigger

PropTypeDefault
asChild
boolean

ItemIndicator

PropTypeDefault
asChild
boolean

ItemGroupLabel

PropTypeDefault
htmlFor
string
asChild
boolean