Y2K UI

Toggle Group

A group of toggle buttons for selecting one or more options from a set.

toggle-group-demo.app

Installation

terminal.sh
npx y2kui@latest add toggle-group

Usage

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

/* Single selection */
<ToggleGroup type="single" defaultValue="a">
  <ToggleGroupItem value="a">A</ToggleGroupItem>
  <ToggleGroupItem value="b">B</ToggleGroupItem>
  <ToggleGroupItem value="c">C</ToggleGroupItem>
</ToggleGroup>

/* Multiple selection */
<ToggleGroup type="multiple" defaultValue={["a", "c"]}>
  <ToggleGroupItem value="a">A</ToggleGroupItem>
  <ToggleGroupItem value="b">B</ToggleGroupItem>
  <ToggleGroupItem value="c">C</ToggleGroupItem>
</ToggleGroup>

Props

PropTypeDefaultDescription
type'single' | 'multiple''single'Allow single or multiple selection.
valuestring | string[]Controlled value.
defaultValuestring | string[]Default value.
onValueChange(value: string) => voidCallback when value changes.

On this page