Toggle group

A row of toggles where one — or several — stay pressed: a granularity, a text alignment, a filter set.

shadcn's base-nova toggle group with one change: orientation reaches Base UI, not just the data attribute the styles read, so a vertical group — a theme switcher stacked in a column, say — moves between its items with Up and Down, where Left and Right do nothing, and a horizontal one with Left and Right. Its items are Vibra's toggle, so they carry its transition list and label register. One item stays pressed at a time unless the group is multiple; spacing={0} joins the items into one control with shared edges.

Install

npx shadcn@latest add @vibra/toggle-group

Needs the @vibra registry in your components.json — set it up once.

Examples

Weekly revenue, the last 12 weeks.

"use client"

import * as React from "react"

import { ToggleGroup, ToggleGroupItem } from "@/components/ui/toggle-group"

const GRANULARITIES = [
  { value: "day", label: "Day", note: "Daily revenue, the last 30 days." },
  { value: "week", label: "Week", note: "Weekly revenue, the last 12 weeks." },
  { value: "month", label: "Month", note: "Monthly revenue, the last 12 months." },
]

export default function ToggleGroupDemo() {
  const [value, setValue] = React.useState<string[]>(["week"])
  const current = GRANULARITIES.find((item) => item.value === value[0])

  return (
    <div className="flex flex-col items-center gap-3">
      <ToggleGroup
        aria-label="Revenue granularity"
        variant="outline"
        spacing={0}
        value={value}
        // One item always stays pressed: pressing the pressed one again keeps it.
        onValueChange={(next) => {
          if (next.length > 0) setValue(next)
        }}
      >
        {GRANULARITIES.map((item) => (
          <ToggleGroupItem key={item.value} value={item.value}>
            {item.label}
          </ToggleGroupItem>
        ))}
      </ToggleGroup>
      <p className="text-xs text-muted-foreground">{current?.note}</p>
    </div>
  )
}

Props

Prop	Type	Default	Description
multiple	boolean	false	Lets several items be pressed at once.
value / defaultValue	readonly string[]	—	The pressed items' values — an array even when only one can be pressed.
variant / size	"default" \| "outline" / "default" \| "sm" \| "lg"	"default" / "default"	Passed to every item.
spacing	number	2	The gap between items in spacing steps; 0 joins them.
orientation	"horizontal" \| "vertical"	"horizontal"	A row or a column, and which arrow keys move between items.

Dependencies

Registry

npm

Source

components/ui/toggle-group.tsx

"use client"

import * as React from "react"
import { Toggle as TogglePrimitive } from "@base-ui/react/toggle"
import { ToggleGroup as ToggleGroupPrimitive } from "@base-ui/react/toggle-group"
import { type VariantProps } from "class-variance-authority"
import { cn } from "@/lib/utils"

import { toggleVariants } from "@/components/ui/toggle"

const ToggleGroupContext = React.createContext<
  VariantProps<typeof toggleVariants> & {
    spacing?: number
    orientation?: "horizontal" | "vertical"
  }
>({
  size: "default",
  variant: "default",
  spacing: 2,
  orientation: "horizontal",
})

function ToggleGroup({
  className,
  variant,
  size,
  spacing = 2,
  orientation = "horizontal",
  children,
  ...props
}: ToggleGroupPrimitive.Props &
  VariantProps<typeof toggleVariants> & {
    spacing?: number
    orientation?: "horizontal" | "vertical"
  }) {
  return (
    <ToggleGroupPrimitive
      data-slot="toggle-group"
      data-variant={variant}
      data-size={size}
      data-spacing={spacing}
      data-orientation={orientation}
      // Base UI's own orientation, not just the attribute the styles read: it
      // decides which arrow keys move between the items.
      orientation={orientation}
      style={{ "--gap": spacing } as React.CSSProperties}
      className={cn(
        "group/toggle-group flex w-fit flex-row items-center gap-[--spacing(var(--gap))] rounded-lg data-[size=sm]:rounded-[min(var(--radius-md),10px)] data-vertical:flex-col data-vertical:items-stretch",
        className
      )}
      {...props}
    >
      <ToggleGroupContext.Provider
        value={{ variant, size, spacing, orientation }}
      >
        {children}
      </ToggleGroupContext.Provider>
    </ToggleGroupPrimitive>
  )
}

function ToggleGroupItem({
  className,
  children,
  variant = "default",
  size = "default",
  ...props
}: TogglePrimitive.Props & VariantProps<typeof toggleVariants>) {
  const context = React.useContext(ToggleGroupContext)

  return (
    <TogglePrimitive
      data-slot="toggle-group-item"
      data-variant={context.variant || variant}
      data-size={context.size || size}
      data-spacing={context.spacing}
      className={cn(
        "shrink-0 group-data-[spacing=0]/toggle-group:rounded-none group-data-[spacing=0]/toggle-group:px-2 focus:z-10 focus-visible:z-10 group-data-[spacing=0]/toggle-group:has-data-[icon=inline-end]:pe-1.5 group-data-[spacing=0]/toggle-group:has-data-[icon=inline-start]:ps-1.5 group-data-horizontal/toggle-group:data-[spacing=0]:first:rounded-s-lg group-data-vertical/toggle-group:data-[spacing=0]:first:rounded-t-lg group-data-horizontal/toggle-group:data-[spacing=0]:last:rounded-e-lg group-data-vertical/toggle-group:data-[spacing=0]:last:rounded-b-lg group-data-horizontal/toggle-group:data-[spacing=0]:data-[variant=outline]:border-s-0 group-data-vertical/toggle-group:data-[spacing=0]:data-[variant=outline]:border-t-0 group-data-horizontal/toggle-group:data-[spacing=0]:data-[variant=outline]:first:border-s group-data-vertical/toggle-group:data-[spacing=0]:data-[variant=outline]:first:border-t",
        toggleVariants({
          variant: context.variant || variant,
          size: context.size || size,
        }),
        className
      )}
      {...props}
    >
      {children}
    </TogglePrimitive>
  )
}

export { ToggleGroup, ToggleGroupItem }