Skip to content

Toggle Group

Choose one or more pressed buttons from a group.

Demos

Size
Variant

Usage

vue
<script setup lang="ts">
import { Accordion } from '~/components/ui/accordion'

const items = [
  { value: 'source', label: 'Do I own the source?', content: 'Yes. Copy and adapt the files.' },
]
</script>

<template>
  <Accordion :items="items" />
</template>

Single selection moves one shared pressed indicator between items, including vertical groups. Multiple selection keeps a separate pressed fill on each selected item. Reduced motion disables sliding.

Installation

Complete the shared installation. Copy ToggleGroup.vue and index.ts into app/components/ui/toggle-group/.

API

Variants and defaults

PropValuesDefault
sizexs, sm, md, lg, xlsm
variantsoft, outlinesoft

Props

PropTypeDefaultDescription
optionsToggleGroupOption[]requiredToggle items.
type"single" | "multiple""single"Selection mode.
valueKeystring—Object key used as item value. Falls back to value, then label.
labelKeystring"label"Object key used as item label.
descriptionKeystring"description"Object key used as item description.
disabledKeystring"disabled"Object key used as item disabled state.
disabledbooleanfalseDisabled state for the whole group.
requiredbooleanfalsePrevents clearing the last selected value.
namestring—Hidden form input name. Multiple mode renders one hidden input per selected value.
orientation"horizontal" | "vertical""horizontal"Roving focus direction.
loopbooleantrueArrow navigation wraps.
rovingFocusbooleantrueEnables arrow-key roving focus.
allowEmptybooleantrueAllows single mode to clear selected item.
ariaLabelstring—Accessible group label.
ariaLabelledbystring—Accessible group label id.
uiToggleGroupUi—Classes for structural parts.

Slots

SlotPropsDescription
itemoption, value, label, description, isPressed, isDisabled, selectCustom item content.

Events

EventPayloadDescription
value-change(value, details)Fired before model updates. details.cancel() prevents the update.

Keyboard

KeyBehavior
Enter / SpaceToggle focused item.
Arrow keysMove focus by orientation.
Home / EndMove focus to first/last enabled item.