createCombobox API
API reference for the createCombobox composable.
Related
Explore these related pages for additional context and usage patterns.
| Page | Category |
|---|---|
| createCombobox | Forms |
| createSelection | Selection |
| useVirtualFocus | System |
| Combobox | Forms |
Functions
createCombobox
(options?: ComboboxOptions) => ComboboxContextCreates a combobox context that orchestrates selection, popover, virtual focus, and adapter-based filtering into a single coordinated state.
createComboboxContext
(options?: ComboboxOptions & { namespace?: string; }) => ContextTrinity<ComboboxContext>Creates a combobox context with dependency injection support.
useCombobox
(namespace?: string) => ComboboxContextInjects the current combobox context from a parent provider.
Options
multiple
MaybeRefOrGetter<boolean> | undefinedmandatory
MaybeRefOrGetter<boolean> | undefineddisabled
MaybeRefOrGetter<boolean> | undefinedstrict
MaybeRefOrGetter<boolean> | undefinederror
MaybeRefOrGetter<boolean> | undefinederrorMessages
MaybeRefOrGetter<MaybeArray<string> | undefined>adapter
ComboboxAdapter | undefineddisplayValue
((value: unknown) => string) | undefinedid
string | undefinedname
string | undefinedform
string | undefinedProperties
selection
SelectionContext<SelectionTicketInput<unknown>, SelectionTicket<SelectionTicketInput<unknown>>>popover
PopoverReturncursor
VirtualFocusReturnquery
ShallowRef<string>display
Readonly<Ref<string, string>>pristine
ShallowRef<boolean>filtered
Ref<Set<ID>, Set<ID>>isEmpty
Ref<boolean, boolean>isLoading
ShallowRef<boolean>isOpen
ShallowRef<boolean>id
stringinputId
stringlistboxId
stringdescriptionId
stringerrorId
stringhasDescription
ShallowRef<boolean>hasError
ShallowRef<boolean>errors
Readonly<Ref<string[], string[]>>isValid
Readonly<Ref<boolean | null, boolean | null>>inputEl
ShallowRef<HTMLElement | null>multiple
booleanstrict
MaybeRefOrGetter<boolean>disabled
MaybeRefOrGetter<boolean>name
string | undefinedform
string | undefined