Select API

API reference for the Select components.

Explore these related pages for additional context and usage patterns.

Page	Category
Select	Forms
createSelection	Selection
createGroup	Selection
useVirtualFocus	System
Popover	Disclosure

Selection.Root

Props

namespace

string | undefined

Namespace for dependency injection (must match SelectionItem namespace)

Default: "v0:selection"

disabled

boolean | undefined

Disables the entire selection instance

Default: false

enroll

boolean | undefined

Auto-select non-disabled items on registration

Default: false

Controls mandatory selection behavior: - false (default): No mandatory selection enforcement - true: Prevents deselecting the last selected item - `force`: Automatically selects the first non-disabled item on registration

Default: false

multiple

boolean | undefined

Enable multi-selection mode (array v-model)

Default: false

modelValue

T | T[] | undefined

Events

update:model-value

[value: T | T[]]

Slots

default

SelectionRootSlotProps

Select.Root

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:select"

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 select

Default: false

multiple

boolean | undefined

Enable multi-selection mode

Default: false

mandatory

boolean | "force" | undefined

Default: false

modelValue

any

Events

update:model-value

[value: any]

Slots

default

SelectRootSlotProps

Select.Activator

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:select"

Slots

default

SelectActivatorSlotProps

Select.Content

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:select"

eager

boolean | undefined

Render content immediately without waiting for first open

Default: false

Slots

default

SelectContentSlotProps

Select.Cue

Props

namespace

string | undefined

Default: "v0:select"

Slots

default

SelectCueSlotProps

Select.HiddenInput

Props

namespace

string | undefined

Default: "v0:select"

Select.Item

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:select"

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

SelectItemSlotProps<V>

Select.Placeholder

Props

namespace

string | undefined

Default: "v0:select"

Slots

default

SelectPlaceholderSlotProps

Select.Value

Props

namespace

string | undefined

Namespace for dependency injection

Default: "v0:select"

Slots

default

SelectValueSlotProps

Selection.Item

Props

id

string | undefined

Unique identifier (auto-generated if not provided)

label

string | undefined

Optional display label (passed through to slot, not used in registration)

value

V | undefined

Value associated with this item

disabled

MaybeRefOrGetter<boolean> | undefined

Disables this specific item

namespace

string | undefined

Namespace for dependency injection

Default: "v0:selection"

Slots

default

SelectionItemSlotProps<V>