# certara-checkbox

<!-- Auto Generated Below -->


## Overview

A checkbox is an input control that allows a user to select one or more options from a number of choices.

## Properties

| Property        | Attribute       | Description                                                                            | Type                                                      | Default      |
| --------------- | --------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------------ |
| `checked`       | `checked`       | The checked state of the checkbox                                                      | `boolean`                                                 | `false`      |
| `disabled`      | `disabled`      | The disabled state of the checkbox                                                     | `boolean`                                                 | `false`      |
| `indeterminate` | `indeterminate` | The indeterminate state of the checkbox. Can only be set via JavaScript                | `boolean`                                                 | `false`      |
| `inputType`     | `input-type`    | Internal prop to make a radio button. Best to use the certara-radio component directly | `"checkbox" \| "radio"`                                   | `'checkbox'` |
| `layout`        | `layout`        | Stacked checkboxes have one per line, inline checkboxes are all on the same line       | `"inline" \| "inline-block" \| "stacked" \| "standalone"` | `'inline'`   |
| `name`          | `name`          | The name of the checkbox                                                               | `string`                                                  | `undefined`  |
| `size`          | `size`          | The size of the checkbox                                                               | `"md" \| "sm"`                                            | `'md'`       |
| `value`         | `value`         | The value of the checkbox                                                              | `any`                                                     | `'on'`       |


## Events

| Event           | Description                                     | Type                                          |
| --------------- | ----------------------------------------------- | --------------------------------------------- |
| `certaraBlur`   | Standard event emitted when checkbox is blurred | `CustomEvent<void>`                           |
| `certaraChange` | Standard event emitted when checkbox is toggled | `CustomEvent<CheckboxChangeEventDetail<any>>` |
| `certaraClick`  | Standard event emitted when checkbox is clicked | `CustomEvent<void>`                           |
| `certaraFocus`  | Standard event emitted when checkbox is focused | `CustomEvent<void>`                           |


## Slots

| Slot     | Description                         |
| -------- | ----------------------------------- |
|          | Content for the label               |
| `"help"` | Help text that sits below the label |


## Dependencies

### Used by

 - [certara-dropdown-checkbox](../dropdown/dropdown-checkbox)
 - [certara-radio](../radio)

### Depends on

- [certara-help-block](../help-block)

### Graph
```mermaid
graph TD;
  certara-checkbox --> certara-help-block
  certara-dropdown-checkbox --> certara-checkbox
  certara-radio --> certara-checkbox
  style certara-checkbox fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------