# Checkbox Group

Checkbox group with min/max selection



<ComponentPreview base="ink" name="checkbox-group-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/ink/checkbox-group
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      npm install ink
      ```

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource src="registry/bases/ink/ui/types.ts" title="components/ui/types.ts" />

      <ComponentSource src="registry/bases/ink/themes/default.ts" title="lib/terminal-themes/default.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-theme.ts" title="hooks/use-theme.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-unicode.ts" title="hooks/use-unicode.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-interaction.tsx" title="hooks/use-interaction.tsx" />

      <ComponentSource src="registry/bases/ink/lib/terminal-symbols.ts" title="lib/terminal-symbols.ts" />

      <ComponentSource base="ink" name="checkbox-group" title="components/ui/checkbox-group.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { CheckboxGroup } from "@/components/ui/checkbox-group";
```

```tsx
<CheckboxGroup
  label="Select toppings"
  options={[
    { value: "cheese", label: "Extra Cheese" },
    { value: "pepperoni", label: "Pepperoni" },
    { value: "mushrooms", label: "Mushrooms" },
  ]}
  onChange={(values) => {}}
/>
```

API Reference [#api-reference]

CheckboxGroup [#checkboxgroup]

| Prop       | Type                         | Default    |
| ---------- | ---------------------------- | ---------- |
| `label`    | `string`                     | -          |
| `options`  | `CheckboxGroupOption[]`      | `required` |
| `value`    | `string[]`                   | -          |
| `onChange` | `(values: string[]) => void` | -          |
| `min`      | `number`                     | -          |
| `max`      | `number`                     | -          |

Notes [#notes]

Accessibility [#accessibility]

termcn exposes the following behavior through Ink's terminal accessibility APIs. This is not a browser ARIA or general WCAG-conformance claim.

* **Keyboard:** Arrow keys move inside the composite; `Home` / `End` select the first or last enabled item; `Enter` / `Space` activate, select, or toggle; `Escape` cancels or closes an owned surface; `Tab` / `Shift+Tab` move between termcn/Ink focus targets.
* **Focus and composition:** Input is active only while the component's focus target is focused, enabled, active, and inside the topmost focus scope.
* **Screen reader:** Ink labels and semantic state expose the component without relying on visual styling alone.