Toggle group

A row of buttons where one (or several) is switched on, such as a view or time-range switcher.

Install

If this is the first component in the project, set up once. This writes ermine.json and copies the theme stylesheet. The installation guide covers Vue, Nuxt and Astro.

npx ermineui init
pnpm dlx ermineui init
yarn dlx ermineui init
bunx ermineui init

Then add the component:

npx ermineui add toggle-group
pnpm dlx ermineui add toggle-group
yarn dlx ermineui add toggle-group
bunx ermineui add toggle-group

That copies 4 files into src/components/ui/toggle-group/, 2 helpers into src/lib/ermine/. Files you already have are kept.

Use

import { ToggleGroup, ToggleGroupItem } from '@/components/ui/toggle-group'
<Pagination v-model="page" :page-count="24" />

<Breadcrumb>
  <BreadcrumbItem href="/projects">Projects</BreadcrumbItem>
  <BreadcrumbItem :as="NuxtLink" to="/projects/storefront">Storefront</BreadcrumbItem>
  <BreadcrumbItem current>Deployments</BreadcrumbItem>
</Breadcrumb>

<Slider v-model="memory" :min="128" :max="3008" :step="64" />

<ToggleGroup v-model="period" aria-label="Period">  <!-- type="multiple" takes an array -->
  <ToggleGroupItem value="7d">7 days</ToggleGroupItem>
  <ToggleGroupItem value="30d">30 days</ToggleGroupItem>
</ToggleGroup>

In Nuxt, with the auto-import setting, the tags work in templates without the import. In Astro, use it inside a Vue island.

What gets copied

FileWhere it goes
ToggleGroup.vuesrc/components/ui/toggle-group/ToggleGroup.vue
ToggleGroupItem.vuesrc/components/ui/toggle-group/ToggleGroupItem.vue
context.tssrc/components/ui/toggle-group/context.ts
index.tssrc/components/ui/toggle-group/index.ts
collection.ts helpersrc/lib/ermine/collection.ts
context.ts helpersrc/lib/ermine/context.ts

The folders are the suggested ones. ermine.json says where yours are.

Source

This is exactly what the command copies. To install by hand, create each file below and the helpers listed above.

ToggleGroup.vue 135 lines
<script setup lang="ts">
import { computed, onMounted, ref, toRef } from 'vue'
import { arrowTarget } from '../../lib/collection'
import { provideToggleGroup } from './context'

const props = withDefaults(
  defineProps<{
    /** "single" works like radio buttons: exactly one is on. "multiple" lets each be switched on its own. */
    type?: 'single' | 'multiple'
    disabled?: boolean
    size?: 'sm' | 'md'
  }>(),
  { type: 'single', size: 'md' },
)

/** The value that is on, or an array of values in multiple mode. */
const value = defineModel<string | string[]>()

const root = ref<HTMLElement | null>(null)
const first = ref<string>()
const on = computed(() => {
  const current = value.value
  if (Array.isArray(current)) return current
  return current === undefined || current === '' ? [] : [current]
})

function toggle(item: string) {
  if (props.type === 'multiple') {
    value.value = on.value.includes(item) ? on.value.filter((other) => other !== item) : [...on.value, item]
  } else {
    // Like a radio button, pressing the one that is on leaves it on.
    value.value = item
  }
}

onMounted(() => {
  first.value = root.value?.querySelector<HTMLElement>('.er-toggle-group-item:not(:disabled)')?.dataset.value
})

provideToggleGroup({
  type: toRef(props, 'type'),
  isOn: (item) => on.value.includes(item),
  toggle,
  disabled: toRef(props, 'disabled'),
  tabStop: computed(() => on.value[0] ?? first.value),
})

function onKeydown(event: KeyboardEvent) {
  const items = Array.from(root.value?.querySelectorAll<HTMLElement>('.er-toggle-group-item:not(:disabled)') ?? [])
  const next = arrowTarget(event, items, 'horizontal')
  if (!next) return
  event.preventDefault()
  next.focus()
  // In single mode the arrow keys choose as they move, the same as native radio buttons.
  if (props.type === 'single') next.click()
}
</script>

<template>
  <div ref="root" class="er-toggle-group" :role="type === 'single' ? 'radiogroup' : 'group'" :data-size="size" @keydown="onKeydown">
    <slot />
  </div>
</template>

<style>
@layer components {
  .er-toggle-group {
    display: inline-flex;
    align-items: center;
    gap: 2px;
    max-width: 100%;
    padding: 3px;
    border-radius: var(--er-radius-lg);
    background: var(--er-muted);
    color: var(--er-muted-foreground);
    overflow-x: auto;
  }

  .er-toggle-group-item {
    display: inline-flex;
    align-items: center;
    justify-content: center;
    gap: 0.375rem;
    height: 1.875rem;
    padding: 0 0.75rem;
    border: 1px solid transparent;
    border-radius: var(--er-radius-md);
    background: transparent;
    color: inherit;
    font-family: inherit;
    font-size: 0.875rem;
    font-weight: var(--er-weight-medium);
    white-space: nowrap;
    cursor: pointer;
    transition:
      background-color var(--er-duration),
      color var(--er-duration),
      box-shadow var(--er-duration);
  }

  .er-toggle-group[data-size='sm'] .er-toggle-group-item {
    height: 1.5rem;
    padding: 0 0.5rem;
    font-size: 0.8125rem;
  }

  .er-toggle-group-item:hover {
    color: var(--er-foreground);
  }

  .er-toggle-group-item[data-state='on'] {
    border-color: light-dark(transparent, var(--er-input));
    background: light-dark(var(--er-background), oklch(1 0 0 / 8%));
    color: var(--er-foreground);
    box-shadow: var(--er-shadow-sm);
  }

  .er-toggle-group-item:focus-visible {
    outline: 2px solid var(--er-ring);
    outline-offset: 2px;
  }

  .er-toggle-group-item:disabled {
    opacity: 0.5;
    pointer-events: none;
  }

  .er-toggle-group-item svg {
    flex-shrink: 0;
    width: 1rem;
    height: 1rem;
  }
}
</style>
ToggleGroupItem.vue 31 lines
<script setup lang="ts">
import { computed } from 'vue'
import { useToggleGroup } from './context'

const props = defineProps<{
  value: string
  disabled?: boolean
}>()

const group = useToggleGroup()
const on = computed(() => group.isOn(props.value))
const single = computed(() => group.type.value === 'single')
</script>

<template>
  <button
    type="button"
    class="er-toggle-group-item"
    :role="single ? 'radio' : undefined"
    :aria-checked="single ? on : undefined"
    :aria-pressed="single ? undefined : on"
    :tabindex="single && group.tabStop.value !== value ? -1 : 0"
    :disabled="disabled || group.disabled.value"
    :data-state="on ? 'on' : 'off'"
    :data-value="value"
    @click="group.toggle(value)"
  >
    <slot />
  </button>
</template>
context.ts 14 lines
import type { Ref } from 'vue'
import { createContext } from '../../lib/context'

export interface ToggleGroupContext {
  type: Ref<'single' | 'multiple'>
  isOn: (value: string) => boolean
  toggle: (value: string) => void
  disabled: Ref<boolean>
  /** In single mode, the one item Tab stops on: the chosen one, or the first when nothing is chosen. */
  tabStop: Ref<string | undefined>
}

export const [provideToggleGroup, useToggleGroup] = createContext<ToggleGroupContext>('ToggleGroup')
index.ts 4 lines
/** Toggle group — a row of buttons where one (or several) is switched on, such as a view or time-range switcher. */
export { default as ToggleGroup } from './ToggleGroup.vue'
export { default as ToggleGroupItem } from './ToggleGroupItem.vue'