# Toggle

A button that switches between two states.

## 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 { Toggle } from "coss-svelte";
</script>

<Toggle>Toggle</Toggle>

```

## Anatomy

- `Toggle`

## API Reference

### Toggle

A button that switches between two states.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `bind:pressed` | `boolean` | `false` | Pressed state for the toggle. Bind with `bind:pressed`. |

**Composition and refs**

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

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

## Implementation Details

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

## 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.json` for the complete local file and dependency closure.
- Toggle is stable in the current source catalog.