Single API

API reference for the Single components.

Explore these related pages for additional context and usage patterns.

Page	Category
Single	Providers
createSingle	Selection
Selection	Providers

Single.Root

Props

namespace

string | undefined

Namespace for dependency injection (must match SingleItem namespace)

Default: "v0:single"

disabled

boolean | undefined

Disables the entire single instance

Default: false

enroll

boolean | undefined

Auto-select non-disabled items on registration

Default: false

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

Default: false

modelValue

T | T[] | undefined

Slots

default

SingleRootSlotProps

Single.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:single"

Slots

default

SingleItemSlotProps<V>