Components › Actions

Toggle group

A set of toggles on one tray: one on at a time, or several. Arrow keys move between them.

Installation

npx plankui@latest add toggle-group

Usage

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

<ToggleGroup type="single" value={align} onValueChange={setAlign} aria-label="Alignment">
  <ToggleGroupItem value="left" aria-label="Align left"><AlignLeftIcon /></ToggleGroupItem>
  <ToggleGroupItem value="center" aria-label="Align centre"><AlignCenterIcon /></ToggleGroupItem>
</ToggleGroup>

API reference

PropTypeDefaultDescription
type"single" | "multiple"requiredOne item on at a time, or any number.
value / defaultValuestring | string[]A string for single, an array for multiple.
onValueChange(value) => voidCalled when an item turns on or off.
variant / size"ghost" | "outline", "sm" | "md" | "lg""ghost", "sm"The look of every item, the same as Toggle.

View the source on GitHub