# Checkbox API

> Auto-generated API reference for `Checkbox` from @vuetify/v0 (Vuetify0).
> Source of truth: https://0.vuetifyjs.com/api/checkbox

## Related

- https://0.vuetifyjs.com/components/forms/checkbox
- https://0.vuetifyjs.com/composables/selection/create-group
- https://0.vuetifyjs.com/components/providers/group

## Checkbox.Root

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `id` | `any` | `useId()` | no | Unique identifier (auto-generated if not provided) |
| `label` | `string \| undefined` | — | no | Optional display label (passed through to slot) |
| `value` | `V \| undefined` | — | no | Value associated with this checkbox (used in group mode and form submission) |
| `name` | `string \| undefined` | — | no | Form field name - triggers auto hidden input when provided |
| `form` | `string \| undefined` | — | no | Associate with form by ID |
| `disabled` | `MaybeRefOrGetter<boolean> \| undefined` | `false` | no | Disables this checkbox |
| `indeterminate` | `MaybeRefOrGetter<boolean> \| undefined` | `false` | no | Sets the indeterminate state |
| `namespace` | `string \| undefined` | `"v0:checkbox:root"` | no | Namespace for context provision to children (Indicator, HiddenInput) |
| `groupNamespace` | `string \| undefined` | `"v0:checkbox:group"` | no | Namespace for connecting to parent Checkbox.Group |
| `ariaLabelledby` | `string \| undefined` | — | no | ID of element that labels this checkbox |
| `ariaDescribedby` | `string \| undefined` | — | no | ID of element that describes this checkbox |
| `ariaInvalid` | `boolean \| undefined` | — | no | Whether the checkbox has an invalid value |
| `modelValue` | `boolean \| undefined` | — | no | — |

### Events

| Name | Type | Description |
|---|---|---|
| `update:model-value` | `[value: boolean]` | — |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `CheckboxRootSlotProps<V>` | — |

## Checkbox.Group

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:checkbox:group"` | no | Namespace for dependency injection |
| `disabled` | `boolean \| undefined` | `false` | no | Disables the entire checkbox group |
| `enroll` | `boolean \| undefined` | `false` | no | Auto-select non-disabled items on registration |
| `mandatory` | `boolean \| "force" \| undefined` | `false` | no | Controls mandatory checkbox behavior: - false (default): No mandatory enforcement - true: Prevents deselecting the last selected item - `force`: Automatically selects the first non-disabled item on registration |
| `label` | `string \| undefined` | — | no | Accessible name for the group |
| `ariaLabelledby` | `string \| undefined` | — | no | ID of element that labels this group |
| `ariaDescribedby` | `string \| undefined` | — | no | ID of element that describes this group |
| `modelValue` | `T \| T[] \| undefined` | — | no | — |

### Events

| Name | Type | Description |
|---|---|---|
| `update:model-value` | `[value: T \| T[]]` | — |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `CheckboxGroupSlotProps` | — |

## Checkbox.HiddenInput

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:checkbox:root"` | no | Namespace for context injection from parent Checkbox.Root |
| `name` | `string \| undefined` | — | no | Form field name (defaults to context value) |
| `value` | `string \| undefined` | — | no | Submitted value when checked (defaults to context value or 'on') |
| `form` | `string \| undefined` | — | no | Associate with form by ID (defaults to context value) |

## Checkbox.Indicator

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:checkbox:root"` | no | Namespace for context injection from parent Checkbox.Root |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `CheckboxIndicatorSlotProps` | — |

## Checkbox.SelectAll

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `label` | `string \| undefined` | — | no | Optional display label (passed through to slot and aria-label) |
| `disabled` | `boolean \| undefined` | — | no | Disables this checkbox |
| `namespace` | `string \| undefined` | `"v0:checkbox:root"` | no | Namespace for context provision to children (Indicator) |
| `groupNamespace` | `string \| undefined` | `"v0:checkbox:group"` | no | Namespace for connecting to parent Checkbox.Group |
| `ariaLabelledby` | `string \| undefined` | — | no | ID of element that labels this checkbox |
| `ariaDescribedby` | `string \| undefined` | — | no | ID of element that describes this checkbox |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `CheckboxSelectAllSlotProps` | — |