[Components](https://oods-foundry.com/components) / primitive

# Checkbox

Toggles a labelled boolean value.

Generated from @oods/foundry 0.10.1

- Categories

  primitive

- Contexts

  form

- Readiness

  `proven-in-generated-apps`

## Playground

This component's contract doesn't list typed props, so the playground shows its documented example.

Documented example `checkbox-controlled` : click checkbox, checked=true emitted once.

The render follows the page's theme switch: light, dark or high contrast. Both frameworks render the same example.

The real Checkbox, live

React

Product updates

Choose whether to subscribe

Vue

Product updates

Choose whether to subscribe

Events it emits: change, update. Use either render above, and each event shows here with the framework that sent it.



## Code

The documented example. HTML is the markup the React component renders for it, which @oods/component-styles styles.

**React**

```
import { Checkbox } from '@oods/components-react';
import '@oods/component-styles/css';

export function Example() {
  return (
    <Checkbox
      id="marketing"
      label="Product updates"
      checked={false}
      required={true}
      help="Choose whether to subscribe"
    />
  );
}
```

## Props, slots and events

Contract version 1.1.0. Types are from the React declarations in @oods/components-react.

Props

| Prop | Type | Required | Documented example |
| - | - | - | - |
| `id` | `string` | yes | `marketing` |
| `label` | `ReactNode` | yes | `Product updates` |
| `checked` | `boolean \| undefined` | no | `false` |
| `defaultChecked` | `boolean \| undefined` | no | |
| `required` | `boolean \| undefined` | no | `true` |
| `disabled` | `boolean \| undefined` | no | |
| `help` | `ReactNode` | no | `Choose whether to subscribe` |
| `validation` | `FieldValidation \| undefined` | no | |

### Slots

label, help, validation

### Events

change, update

## States

unchecked, checked, disabled, invalid

## Accessibility

- Role

  `checkbox`

- How it gets its name

  `label` on `input[type="checkbox"]`

### Keyboard

Keyboard

| Key | What it does |
| - | - |
| `Tab` | Move focus to the named native control |
| `` | Activate the control |

### Obligations in the contract

- Native checkbox semantics
- Label and help/error descriptions are programmatically associated

Indeterminate remains unsupported until implemented and tested in both targets.

## Tokens

The token roles this component reads.

- `checkbox.background`
- `checkbox.border`
- `checkbox.check`
- `checkbox.focus`
- `field.message`

## Readiness

The evidence recorded for this component, with its label.

`proven-in-generated-apps`: catalog_list gives this label when generated React and Vue apps in the runtime sweep that ships with this version both use the component. That sweep was measured on the published 0.4.1, not on this version.

Readiness evidence

| Evidence | React | Vue |
| - | - | - |
| state | implemented-evidence-complete | implemented-evidence-complete |
| versioned contract | passed | passed |
| target implementation | passed | passed |
| package export | passed | passed |
| public declaration | passed | passed |
| dependency closure | passed | passed |
| framework scenario | passed | passed |
| accessibility | verified | verified |
| interaction | verified | verified |
| visual themes | verified | verified |

## Use your own

You can replace this component with your own React or Vue component. Map it, and generated code imports yours at the exact version you name. A contract report, run in a real browser, lists what your component met, what it didn't, and what wasn't checked.

The `component_map` call, with the parts in angle brackets yours to fill:

```
{
  "action": "create",
  "apply": true,
  "externalSystem": "<your design system>",
  "externalComponent": "<YourCheckbox>",
  "oodsTraits": [
    "<trait names>"
  ],
  "substitution": {
    "component": "Checkbox",
    "react": {
      "package": "<your-package>/react",
      "version": "<exact version>",
      "export": "<YourCheckbox>"
    },
    "vue": {
      "package": "<your-package>/vue",
      "version": "<exact version>",
      "export": "<YourCheckbox>"
    }
  }
}
```

## How this page was made

Generated at build from the published data, each source with the hash of what was read. [The page's manifest](https://oods-foundry.com/components/checkbox/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.Checkbox` `sha256:9df5d611f18e…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios checkbox-controlled` `sha256:1c9fef1172fe…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json Checkbox` `sha256:92c39c482623…`
- **React readiness**: `@oods/components-react@0.10.1 readiness Checkbox` `sha256:85a93e43416b…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness Checkbox` `sha256:031475e93354…`
- **Prop types**: `generated/0.10.1/components/prop-types.json Checkbox` `sha256:031c62e04f16…`