Combobox API

API reference for the Combobox components.

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

namespace

string | undefined

Namespace for dependency injection

Default: "v0:combobox"

id

string | undefined

Unique identifier (auto-generated if not provided)

name

string | undefined

Form field name — auto-renders hidden input when provided

form

string | undefined

Associate with a form by ID

disabled

boolean | undefined

Disables the entire combobox

Default: false

multiple

boolean | undefined

Enable multi-selection mode

Default: false

mandatory

boolean | undefined

Controls mandatory selection behavior: - false (default): No mandatory selection enforcement - true: Prevents deselecting the last selected item

Default: false

strict

boolean | undefined

Strict mode: reverts query to selected value on close if no match

Default: false

error

boolean | undefined

Manual error state override — forces invalid regardless of error messages

Default: false

errorMessages

any

Manual error messages

adapter

any

Filtering/loading adapter (client-side or server-side)

displayValue

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

Maps selected value to input display text. Defaults to String(value).

modelValue

any

Events

update:model-value

[value: any]

Slots

default

ComboboxRootSlotProps

Combobox.Activator

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:combobox"

Slots

default

ComboboxActivatorSlotProps

Combobox.Content

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:combobox"

eager

boolean | undefined

Render content immediately without waiting for first open

Default: false

Slots

default

ComboboxContentSlotProps

Combobox.Control

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:combobox"

openOn

"focus" | "input" | undefined

When to open the dropdown

Default: "focus"

placeholder

string | undefined

Placeholder text

Slots

default

ComboboxControlSlotProps

Combobox.Cue

Props

namespace

string | undefined

Default: "v0:combobox"

Slots

default

ComboboxCueSlotProps

Combobox.Description

Props

namespace

string | undefined

Namespace for connecting to parent Combobox.Root

Default: "v0:combobox"

Slots

default

ComboboxDescriptionSlotProps

Combobox.Empty

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:combobox"

Slots

default

ComboboxEmptySlotProps

Combobox.Error

Props

namespace

string | undefined

Namespace for connecting to parent Combobox.Root

Default: "v0:combobox"

Slots

default

ComboboxErrorSlotProps

Combobox.HiddenInput

Props

namespace

string | undefined

Default: "v0:combobox"

Combobox.Item

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:combobox"

id

string | undefined

Unique identifier (auto-generated if not provided)

value

V | undefined

Value associated with this option

disabled

MaybeRefOrGetter<boolean> | undefined

Disables this specific option

Slots

default

ComboboxItemSlotProps<V>