# Checkbox

A binary toggle input for selecting one or multiple options.

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

<Label>
	<Checkbox />
	Accept terms and conditions
</Label>

```

## Anatomy

- `Checkbox`

## API Reference

### Checkbox

A binary toggle input for selecting one or multiple options.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `id` | `string` | - | ID forwarded to the form control. |
| `bind:checked` | `boolean` | `false` | Checked state for the control. Bind with `bind:checked` when supported. |
| `bind:indeterminate` | `boolean` | `false` | Displays the checkbox in an indeterminate state. |
| `label` | `string` | `""` | Accessible label or fallback visible label for the control. |

**Composition and refs**

- `bind:ref: HTMLElement \| null`

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

## Implementation Details

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

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