# Toggle Group

A group of toggle buttons where one or multiple can be selected.

## Installation

Start from a Svelte 5 application, then install the component package, shared theme, and Bits UI peer:

```bash
pnpm add coss-svelte @coss-svelte/theme bits-ui
```

Import `@coss-svelte/theme/style-coss.css` after Tailwind from the application's global stylesheet.

## Usage

```svelte
<script lang="ts">
import { Bold, Italic, Underline } from "@lucide/svelte";
import { ToggleGroup, ToggleGroupItem } from "coss-svelte";
</script>

<ToggleGroup type="multiple" value={["bold"]}>
	<ToggleGroupItem aria-label="Toggle bold" value="bold"><Bold /></ToggleGroupItem>
	<ToggleGroupItem aria-label="Toggle italic" value="italic"><Italic /></ToggleGroupItem>
	<ToggleGroupItem aria-label="Toggle underline" value="underline"><Underline /></ToggleGroupItem>
</ToggleGroup>

```

## Anatomy

- `ToggleGroup`
- `ToggleGroupItem`

## API Reference

### ToggleGroup

A group of toggle buttons where one or multiple can be selected.

**Signatures**

- `{ type?: "single"; value?: string; onValueChange?: OnChangeFn<string> }`
- `{ type: "multiple"; value?: string[]; onValueChange?: OnChangeFn<string[]> }`

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `type` | `"single" \| "multiple"` | `"button"` | Behavior, selection, or HTML type passed to the underlying control. |
| `bind:value` | `string \| string[]` | `""` | Current value for the component. Bind with `bind:value` when supported. |
| `items` | `ToggleItem[]` | `[]` | Items rendered by the component's built-in fallback composition. |

**Composition and refs**

- `children: Snippet<[]>`
- `bind:ref: HTMLElement \| null`

Inherits from [Bits UI ToggleGroup.Root](https://bits-ui.com/docs/components/toggle-group#root).

### ToggleGroupItem

Renders one item inside a toolbar group.

**Composition and refs**

- `children: Snippet<[]>`
- `bind:ref: HTMLElement \| null`

Inherits from [Bits UI ToggleGroup.Item](https://bits-ui.com/docs/components/toggle-group#item).

## Implementation Details

| Field | Value |
| --- | --- |
| Status | Stable |
| Foundation | bits |
| Category | Toggle & Choice |
| Particles | 9 |

## Status

Stable for the current coss-svelte surface.

## Agent Notes

- Import Svelte exports directly from `coss-svelte`.
- This is Svelte 5 code: use `class`, lowercase event properties, runes, snippets, and documented `bind:*` contracts. Do not emit JSX, React hooks, `className`, `asChild`, or Base UI imports.
- Prefer this route's example and generated API table over React COSS snippets; COSS React particles are design references only.
- The copy-and-own registry is a preview. Inspect `/r/toggle-group.json` for the complete local file and dependency closure.
- Toggle Group is stable in the current source catalog.