Skip to content
GaudiGaudi Design System home

Search documentation

Search every page, heading and paragraph.

ToggleGroup

Single or multiple pressed choices for view modes and compact formatting controls.

CoreBasics@gaudi/design-system/core/ToggleGroupView in StorybookSource

Installation

pnpm add github:ahmadassaf/design-system

Import from @gaudi/design-system. Load @gaudi/design-system/global.css once and add transpilePackages: ['@gaudi/design-system'] in Next.js.

import ToggleGroup from '@gaudi/design-system/core/ToggleGroup';

Copy an example into your project with the shadcn CLI: npx shadcn@latest add https://design.gaudi.site/r/toggle-group-filters.json.

Usage

import ToggleGroup from '@gaudi/design-system/core/ToggleGroup';
<ToggleGroup type='single' label='Display' value={view} onValueChange={setView} options={[{ value: 'list', label: 'List' }, { value: 'grid', label: 'Grid' }]} />

Examples

Filters

Storybook

Icon and label switchers

Storybook

Group variants, spacing, sizes and orientation

Storybook

Toggle that swaps icon and label

Storybook

Reactions and counts

Storybook

Toggle variants, sizes and states

Storybook

API

9 props

Accessibility

Each item communicates its pressed state. Choose radio controls when a form requires exactly one persistent choice.