Skip to content

Toggle Button Group

@astryxdesign/core v0.7.1 · ToggleButtonGroup

Props ​

NameTypeDefaultDescription
labelstring-Accessible name, rendered as aria-label.
type'single' | 'multiple''single'single keeps one member pressed. multiple presses members independently.
valuestring | null | string[]nullThe pressed member, or the list of them. Bind with v-model:value.
orientation'horizontal' | 'vertical''horizontal'Layout direction.
size'sm' | 'md' | 'lg''md'Size the members inherit. A member's own size wins.
isDisabledbooleanfalseDisables every member. A member can still disable itself.

Events ​

NamePayloadDescription
update:valuestring | null | string[]The next selection.
changestring | null | string[]Emitted with update:value.

Slots ​

The default slot is the ToggleButton members. Each member that participates needs a value.