Selection API

A headless component for managing selection state in collections with support for single and multi-selection patterns.

Explore these related pages for additional context and usage patterns.

Page	Category
Selection	Providers
createSelection	Selection
Single	Providers
Group	Providers

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

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>