--- title: "Checkbox" slug: checkbox category: component type: overview version: 20.0.0 tokens: 348 source: https://ovh.github.io/design-system/v20.0.0/llms/react-components-checkbox.txt --- # Checkbox _**Checkbox** are used for a list of options where the user may make a choice by selecting multiple options, including all or none._ ## Props | Property | Type | Required | Default | Description | |---|---|---|---|---| | `checked` | `CheckboxCheckedState` | No | undefined | The controlled checked state of the checkbox. | | `defaultChecked` | `boolean` | No | undefined | The initial checked state of the checkbox. Use when you don't need to control the checked state of the checkbox. | | `disabled` | `boolean` | No | undefined | Whether the component is disabled. | | `invalid` | `boolean` | No | undefined | Whether the component is in error state. | | `name` | `string` | No | undefined | The name of the form element. Useful for form submission. | | `onCheckedChange` | `(detail: CheckboxCheckedChangeDetail) => void` | No | undefined | Callback fired when the checked state changes. | | `required` | `boolean` | No | undefined | Whether the component is required. | | `value` | `string` | No | undefined | The value of form element. Useful for form submission. | ## Examples - Default - Disabled - Invalid - States - Group - In Form Field ## Documentation pages - [Documentation](./react-components-checkbox--documentation.txt) - [Technical Information](./react-components-checkbox--technical-information.txt) - [Examples](./react-components-checkbox--examples.txt)