# Checkbox Group

> Source: https://design.nanatec.co.ke/components/checkbox-group/
> Groups related `nana-checkbox` elements under one label, lays them out, and propagates a shared `size`/`disabled`. Tracks the set of checked values and emits them on change.

Groups related `nana-checkbox` elements under one label, lays them out, and propagates a shared `size`/`disabled`. Tracks the set of checked values and emits them on change.

## Preview

```html
<nana-checkbox-group label="Toppings">
  <nana-checkbox value="cheese">Cheese</nana-checkbox>
  <nana-checkbox value="mushroom">Mushroom</nana-checkbox>
</nana-checkbox-group>
```

## Installation

```bash
npm install @nana-tec/ui-components
```

## Import

```js
import "@nana-tec/ui-components/checkbox-group";
```

## Basic usage

```html
<nana-checkbox-group label="Toppings">
  <nana-checkbox value="cheese">Cheese</nana-checkbox>
  <nana-checkbox value="mushroom">Mushroom</nana-checkbox>
</nana-checkbox-group>
```

## API

## Events

| Event | Type | Description |
|---|---|---|
| `nana-change` | `CustomEvent` | Fired when any child toggles (`detail.value` = checked values) |

## Slots

| Slot | Description |
|---|---|
| `(default)` | One or more `nana-checkbox` elements |

## CSS Parts

| Part | Description |
|---|---|
| `legend` | The group label |
| `items` | The layout container |

## Accessibility

<ul class="a11y-grid not-content">
  <li>Keyboard accessible</li>
  <li>Screen-reader labels</li>
  <li>Focus-visible states</li>
  <li>ARIA roles and states</li>
  <li>WCAG 2.2 AA contrast</li>
</ul>

## Related components

<ul class="related not-content">
  <li><a href="/components/button/">Button</a></li>
  <li><a href="/components/button-group/">Button Group</a></li>
  <li><a href="/components/icon-button/">Icon Button</a></li>
  <li><a href="/components/input/">Input</a></li>
  <li><a href="/components/textarea/">Textarea</a></li>
</ul>

## Storybook

See every state and prop interactively in Storybook: https://storybook.nanatec.co.ke/?path=/docs/components-checkbox-group--docs