# Checkbox Group

A collection of related checkboxes with group-level control.

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

<CheckboxGroup aria-label="Select frameworks" value={["next"]}>
	<Label><Checkbox value="next" /> Next.js</Label>
	<Label><Checkbox value="vite" /> Vite</Label>
	<Label><Checkbox value="astro" /> Astro</Label>
</CheckboxGroup>

```

## Anatomy

- `CheckboxGroup`

## API Reference

### CheckboxGroup

A collection of related checkboxes with group-level control.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `label` | `string` | `""` | Accessible label or fallback visible label for the control. |

**Composition and refs**

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

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

## Implementation Details

| Field | Value |
| --- | --- |
| Status | Stable |
| Foundation | custom |
| 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-group.json` for the complete local file and dependency closure.
- Checkbox Group is stable in the current source catalog.