Combobox API

API reference for the Combobox components.

Combobox.Root

Props

namespace

string

Namespace for dependency injection

Default: "v0:combobox"

id

string

Unique identifier (auto-generated if not provided)

disabled

boolean

Disables the entire combobox

Default: false

name

string

Form field name — auto-renders hidden input when provided

form

string

Associate with a form by ID

multiple

boolean

Enable multi-selection mode

Default: false

mandatory

boolean

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

Default: false

strict

boolean

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

Default: false

error

boolean

Manual error state override — forces invalid regardless of error messages

Default: false

errorMessages

MaybeArray<string>

Manual error messages

adapter

ComboboxAdapterInterface

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

displayValue

(value: unknown) => string

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

Namespace for dependency injection

Default: "v0:combobox"

Slots

default

ComboboxActivatorSlotProps

Combobox.Content

Props

namespace

string

Namespace for dependency injection

Default: "v0:combobox"

eager

boolean

Render content immediately without waiting for first open

Default: false

Slots

default

ComboboxContentSlotProps

Combobox.Control

Props

namespace

string

Namespace for dependency injection

Default: "v0:combobox"

openOn

"focus" | "input"

When to open the dropdown

Default: "focus"

placeholder

string

Placeholder text

Slots

default

ComboboxControlSlotProps

Combobox.Cue

Props

namespace

string

Default: "v0:combobox"

Slots

default

ComboboxCueSlotProps

Combobox.Description

Props

namespace

string

Namespace for connecting to parent Combobox.Root

Default: "v0:combobox"

Slots

default

ComboboxDescriptionSlotProps

Combobox.Empty

Props

namespace

string

Namespace for dependency injection

Default: "v0:combobox"

Slots

default

ComboboxEmptySlotProps

Combobox.Error

Props

namespace

string

Namespace for connecting to parent Combobox.Root

Default: "v0:combobox"

Slots

default

ComboboxErrorSlotProps

Combobox.HiddenInput

Props

namespace

string

Default: "v0:combobox"

Combobox.Item

Props

namespace

string

Namespace for dependency injection

Default: "v0:combobox"

id

string

Unique identifier (auto-generated if not provided)

value

V

Value associated with this option

disabled

MaybeRefOrGetter<boolean>

Disables this specific option

Slots

default

ComboboxItemSlotProps<V>