---
title: Toggle Group
description: Provides a shared state to a series of toggle buttons.

links:
  doc: https://base-ui.com/react/components/toggle-group#api-reference
---

## Preview

<ComponentPreview name="p-toggle-group-1" />

## Installation

<CodeTabs>

<TabsList>
  <TabsTab value="cli">CLI</TabsTab>
  <TabsTab value="manual">Manual</TabsTab>
</TabsList>

<TabsPanel value="cli">

```bash
npx @olyx/cli@latest add toggle-group
```

</TabsPanel>

<TabsPanel value="manual">

<Steps>

<Step>Install the following dependencies:</Step>

```bash
npm install @base-ui/react
```

<Step>Copy and paste the following code into your project.</Step>

<ComponentSource name="toggle-group" title="components/ui/toggle-group.tsx" />

<Step>Update the import paths to match your project setup.</Step>

</Steps>

</TabsPanel>

</CodeTabs>

## Usage

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

```tsx
<ToggleGroup>
  <ToggleGroupItem value="bold">Bold</ToggleGroupItem>
  <ToggleGroupItem value="italic">Italic</ToggleGroupItem>
  <ToggleGroupItem value="underline">Underline</ToggleGroupItem>
</ToggleGroup>
```

## API Reference

### ToggleGroup

Root component. Styled wrapper for `ToggleGroup.Root` from Base UI. Provides shared variant and size to child toggles via context.

| Prop      | Type                    | Default     |
| --------- | ----------------------- | ----------- |
| `variant` | `"primary" \| "ghost"`  | `"primary"` |
| `size`    | `"sm" \| "md" \| "lg"` | `"md"`      |
| `grouped` | `boolean`               | `true`      |

### ToggleGroupItem

Individual toggle button within the group. Styled wrapper for `Toggle.Root` from Base UI. Inherits variant and size from parent `ToggleGroup` context.

All props from [Base UI ToggleGroup](https://base-ui.com/react/components/toggle-group#api-reference) are also supported.

## Examples

### Small

<ComponentPreview name="p-toggle-group-2" />

### Large

<ComponentPreview name="p-toggle-group-3" />

### Ghost

<ComponentPreview name="p-toggle-group-4" />

### Ungrouped

<ComponentPreview name="p-toggle-group-5" />

### Vertical

<ComponentPreview name="p-toggle-group-6" />

### Disabled

<ComponentPreview name="p-toggle-group-7" />