Segmented control

One choice from two to five, side by side in a single track: monthly or yearly, list or grid, cm or inches.

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 segmented-control
pnpm dlx ermineui add segmented-control
yarn dlx ermineui add segmented-control
bunx ermineui add segmented-control

That copies 4 files into src/components/ui/segmented-control/, 1 helper into src/lib/ermine/. Files you already have are kept.

Use

import { SegmentedControl, SegmentedControlItem } from '@/components/ui/segmented-control'
<QuantityStepper v-model="quantity" :max="stock" removable label="Quantity of Wool throw" @remove="remove(item)" />
<WishlistButton v-model="saved" label="Save Wool throw for later" />

<SegmentedControl v-model="view" label="View">
  <SegmentedControlItem value="grid">Grid</SegmentedControlItem>
  <SegmentedControlItem value="list">List</SegmentedControlItem>
</SegmentedControl>

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
SegmentedControl.vuesrc/components/ui/segmented-control/SegmentedControl.vue
SegmentedControlItem.vuesrc/components/ui/segmented-control/SegmentedControlItem.vue
context.tssrc/components/ui/segmented-control/context.ts
index.tssrc/components/ui/segmented-control/index.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.

SegmentedControl.vue 129 lines
<script setup lang="ts">
import { computed, toRef, useId } from 'vue'
import { provideSegmentedControl } from './context'

const props = withDefaults(
  defineProps<{
    /** Accessible name: what is being chosen, e.g. "Billing period". */
    label: string
    /** Submit the choice with a form under this name. One is made up when you leave it out. */
    name?: string
    disabled?: boolean
    size?: 'sm' | 'md'
    /** Stretch across the space available, with every segment the same width. */
    block?: boolean
  }>(),
  { size: 'md' },
)

const value = defineModel<string>()

const fallbackName = useId()

provideSegmentedControl({
  value,
  select: (next) => {
    value.value = next
  },
  name: computed(() => props.name ?? fallbackName),
  disabled: toRef(props, 'disabled'),
})
</script>

<template>
  <div class="er-segmented-control" role="radiogroup" :aria-label="label" :data-size="size" :data-block="block ? '' : undefined" :data-disabled="disabled ? '' : undefined">
    <slot />
  </div>
</template>

<style>
@layer components {
  .er-segmented-control {
    display: inline-flex;
    gap: 0.125rem;
    max-width: 100%;
    padding: 0.1875rem;
    border-radius: var(--er-radius-control);
    background: var(--er-muted);
  }

  .er-segmented-control[data-block] {
    display: flex;
  }

  .er-segmented-control[data-block] .er-segmented-control-item {
    flex: 1;
  }

  .er-segmented-control[data-disabled] {
    opacity: 0.5;
  }

  .er-segmented-control-item {
    position: relative;
    display: inline-flex;
    align-items: center;
    justify-content: center;
    gap: 0.375rem;
    min-width: 0;
    height: 1.875rem;
    padding: 0 0.75rem;
    border-radius: calc(var(--er-radius-control) - 2px);
    color: var(--er-muted-foreground);
    font-size: 0.875rem;
    font-weight: var(--er-weight-medium);
    line-height: 1;
    white-space: nowrap;
    cursor: pointer;
    user-select: none;
    transition:
      background-color var(--er-duration),
      color var(--er-duration),
      box-shadow var(--er-duration);
  }

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

  .er-segmented-control-item:hover {
    color: var(--er-foreground);
  }

  .er-segmented-control-item[data-state='on'] {
    background: var(--er-background);
    color: var(--er-foreground);
    box-shadow: var(--er-shadow-sm);
  }

  /* A real radio button covers the whole segment, so forms, labels and the arrow keys work as usual. */
  .er-segmented-control-item input {
    position: absolute;
    inset: 0;
    width: 100%;
    height: 100%;
    margin: 0;
    opacity: 0;
    cursor: inherit;
  }

  .er-segmented-control-item:has(input:focus-visible) {
    outline: 2px solid var(--er-ring);
    outline-offset: 1px;
  }

  .er-segmented-control-item:has(input:disabled) {
    opacity: 0.5;
    cursor: not-allowed;
  }

  .er-segmented-control-item svg {
    flex-shrink: 0;
    width: 1rem;
    height: 1rem;
  }
}
</style>
SegmentedControlItem.vue 30 lines
<script setup lang="ts">
import { computed } from 'vue'
import { useSegmentedControl } from './context'

const props = defineProps<{
  value: string
  /** Accessible name. Needed when the segment holds only an icon; otherwise the text inside is used. */
  label?: string
  disabled?: boolean
}>()

const group = useSegmentedControl()
const on = computed(() => group.value.value === props.value)
</script>

<template>
  <label class="er-segmented-control-item" :data-state="on ? 'on' : 'off'">
    <input
      type="radio"
      :name="group.name.value"
      :value="value"
      :checked="on"
      :disabled="disabled || group.disabled.value"
      :aria-label="label"
      @change="group.select(value)"
    />
    <slot>{{ label ?? value }}</slot>
  </label>
</template>
context.ts 13 lines
import type { Ref } from 'vue'
import { createContext } from '../../lib/context'

export interface SegmentedControlContext {
  value: Ref<string | undefined>
  select: (value: string) => void
  /** Shared by every segment: it is what makes the arrow keys move between them. */
  name: Ref<string>
  disabled: Ref<boolean>
}

export const [provideSegmentedControl, useSegmentedControl] = createContext<SegmentedControlContext>('SegmentedControl')
index.ts 4 lines
/** Segmented control — one choice from two to five, side by side in a single track: monthly or yearly, list or grid, cm or inches. */
export { default as SegmentedControl } from './SegmentedControl.vue'
export { default as SegmentedControlItem } from './SegmentedControlItem.vue'