Skip to main content

Theme

Mode

Palettes

Accessibility

createCombobox API

Low-level combobox coordinator for custom implementations. Most users should use the Combobox component instead.

Explore these related pages for additional context and usage patterns.

Page	Category
createCombobox	Forms
createSelection	Selection
useVirtualFocus	System
createVirtual	Data
Combobox	Forms

Functions

createCombobox

(options?: ComboboxOptions) => ComboboxContext

Creates 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) => ComboboxContext

Injects the current combobox context from a parent provider.

Options

multiple

MaybeRefOrGetter<boolean> | undefined

mandatory

MaybeRefOrGetter<boolean> | undefined

disabled

MaybeRefOrGetter<boolean> | undefined

strict

MaybeRefOrGetter<boolean> | undefined

error

MaybeRefOrGetter<boolean> | undefined

errorMessages

MaybeRefOrGetter<MaybeArray<string> | undefined>

adapter

ComboboxAdapter | undefined

positionAdapter

PopoverAdapter | undefined

Positioning engine for the dropdown.

Default: CSS anchor positioning (`V0PopoverAdapter`)

displayValue

((value: unknown) => string) | undefined

id

string | undefined

name

string | undefined

form

string | undefined

Properties

selection

SelectionContext<ComboboxTicketInput<unknown>, ComboboxTicket<ComboboxTicketInput<unknown>>>

PopoverReturn

cursor

VirtualFocusReturn

query

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

string

inputId

string

listboxId

string

descriptionId

string

errorId

string

hasDescription

ShallowRef<boolean>

hasError

ShallowRef<boolean>

errors

Readonly<Ref<string[], string[]>>

isValid

Readonly<Ref<boolean | null, boolean | null>>

inputEl

ShallowRef<HTMLElement | null>

multiple

Readonly<Ref<boolean, boolean>>

strict

MaybeRefOrGetter<boolean>

disabled

MaybeRefOrGetter<boolean>

name

string | undefined

form

string | undefined

Methods

open

() => void

close

() => void

toggle

() => void

commit

() => void

select

(id: ID) => void

clear

() => void

Was this page helpful?