Group API

A headless component for managing multi-selection with batch operations and tri-state support.

Explore these related pages for additional context and usage patterns.

Page	Category
Group	Providers
createGroup	Selection
Selection	Providers

Group.Root

Props

namespace

string | undefined

Namespace for dependency injection (must match GroupItem namespace)

Default: "v0:group"

disabled

boolean | undefined

Disables the entire group instance

Default: false

enroll

boolean | undefined

Auto-select non-disabled items on registration

Default: false

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

Default: false

modelValue

T | T[] | undefined

Events

update:model-value

[value: T | T[]]

Slots

default

GroupRootSlotProps

Group.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

indeterminate

MaybeRefOrGetter<boolean> | undefined

Sets the indeterminate state (for checkboxes)

Default: false

namespace

string | undefined

Namespace for dependency injection

Default: "v0:group"

Slots

default

GroupItemSlotProps<V>