One-of-many view
Use single mode for mutually exclusive display choices.
Components / Actions
Coordinates a roving set of single- or multiple-selection toggle buttons.
Last changed in version 0.14.2: Improve keyboard navigation, action feedback, and selected colors across Vue components.
bunx --bun @getweini/cli@latest add toggle-groupImport the files copied by the install command, then place the component in your Vue template. The text and values in the example belong to your app; change them to fit your task.
<script setup lang="ts">
import { ref } from 'vue'
import ToggleGroup from './components/ui/toggle-group/ToggleGroup.vue'
import ToggleGroupItem from './components/ui/toggle-group/ToggleGroupItem.vue'
const alignment = ref<string>()
</script>
<template>
<ToggleGroup v-model="alignment" aria-label="Text alignment">
<ToggleGroupItem value="left">Left</ToggleGroupItem>
<ToggleGroupItem value="center">Center</ToggleGroupItem>
<ToggleGroupItem value="right">Right</ToggleGroupItem>
</ToggleGroup>
</template>Name the root with aria-label or aria-labelledby. Arrow keys follow orientation and text direction, Home and End move to the edges, and disabled items are skipped.
Use single mode for mutually exclusive display choices.
Use multiple mode when several options can be active together.
Single mode stores one selected value.
<script setup lang="ts">
import { ref } from 'vue'
import ToggleGroup from './components/ui/toggle-group/ToggleGroup.vue'
import ToggleGroupItem from './components/ui/toggle-group/ToggleGroupItem.vue'
const density = ref<string>()
</script>
<template>
<ToggleGroup v-model="density" type="single" aria-label="List density">
<ToggleGroupItem value="compact">Compact</ToggleGroupItem>
<ToggleGroupItem value="comfortable">Comfortable</ToggleGroupItem>
</ToggleGroup>
</template>Multiple mode stores an array of active values.
<script setup lang="ts">
import { ref } from 'vue'
import ToggleGroup from './components/ui/toggle-group/ToggleGroup.vue'
import ToggleGroupItem from './components/ui/toggle-group/ToggleGroupItem.vue'
const layers = ref<string[]>(['roads'])
</script>
<template>
<ToggleGroup v-model="layers" type="multiple" aria-label="Map layers">
<ToggleGroupItem value="roads">Roads</ToggleGroupItem>
<ToggleGroupItem value="transit">Transit</ToggleGroupItem>
<ToggleGroupItem value="terrain">Terrain</ToggleGroupItem>
</ToggleGroup>
</template>Every public prop, model, event, slot, and exposed member of the installed Vue parts is listed below. “Not set” means you can leave that value out; “Required” means you must provide it. Native HTML attributes also work where the component uses a native element.
| Name | Type or signature | Default | What it does |
|---|---|---|---|
typeprop | "single" | "multiple" | undefined | "single" | Choose the native HTML control type or action behavior. |
orientationprop | "horizontal" | "vertical" | undefined | "horizontal" | Arrange items horizontally or vertically. |
disabledprop | boolean | undefined | Not set | Prevent interaction and show the disabled state. |
loopprop | boolean | undefined | true | Wrap keyboard navigation from the last item to the first. |
modelValuemodel | ToggleGroupValue | undefined | Current value. Use v-model to keep it in sync with your page. |
update:modelValueevent | [value: ToggleGroupValue] | — | Requests a new model value from the parent. |
defaultslot | () => unknown | Required | Content shown inside ToggleGroup. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
valueprop | string | Required | Value represented by this control or option. |
disabledprop | boolean | undefined | Not set | Prevent interaction and show the disabled state. |
defaultslot | (props: { pressed: boolean; }) => unknown | Required | Content shown inside ToggleGroupItem. |
elementexposed | HTMLButtonElement | null | — | Reference to the underlying HTML element. |
focusexposed | () => void | undefined | — | Move keyboard focus to this control. |
// packages/frameworks/vue/components/toggle-group/types.ts
// ------- TYPES -------
export type ToggleGroupValue = string | string[] | undefined
export interface ToggleGroupProps {
type?: 'single' | 'multiple'
orientation?: 'horizontal' | 'vertical'
disabled?: boolean
loop?: boolean
}
export interface ToggleGroupItemProps {
value: string
disabled?: boolean
}