npm package: @paprika/checkbox
Description: Checkbox component displays a checkbox and label text beside it. When clicked it displays a checkmark. It can also have an indeterminate state which can be used to group checkboxes.
Author: @paprika
Latest version: 1.0.30

<!-- start: Autogenerated - do not modify -->

# @paprika/checkbox

## Description

Checkbox component displays a checkbox and label text beside it. When clicked it displays a checkmark. It can also have an indeterminate state which can be used to group checkboxes.

## Installation

```
yarn add @paprika/checkbox
```

or with npm:

```
npm install @paprika/checkbox
```

## Props

### Checkbox

| Prop         | Type                                                                                                | required | default                        | Description                                                |
| ------------ | --------------------------------------------------------------------------------------------------- | -------- | ------------------------------ | ---------------------------------------------------------- |
| a11yText     | string                                                                                              | false    | null                           | Used for aria-label on the checkbox input                  |
| checkedState | [ Checkbox.types.state.CHECKED, Checkbox.types.state.UNCHECKED, Checkbox.types.state.INDETERMINATE] | false    | Checkbox.types.state.UNCHECKED | The checkbox state                                         |
| children     | node                                                                                                | false    | null                           | Used for label contents                                    |
| isDisabled   | bool                                                                                                | false    | false                          | Describe if the checkbox is disabled or not                |
| onChange     | func                                                                                                | false    | () => {}                       | Callback triggered when the input state is changed         |
| size         | [ Checkbox.types.size.SMALL, Checkbox.types.size.MEDIUM, Checkbox.types.size.LARGE]                 | false    | Checkbox.types.size.MEDIUM     | Size provided by parent Group component                    |
| tabIndex     | [number,string]                                                                                     | false    | 0                              | Value for tabindex attribute to override the default of 0. |

<!-- end: Autogenerated - do not modify -->
<!-- content -->

## Usage

```js
import Checkbox from "@paprika/checkbox";

<Checkbox onChange={handleChange} checkState={checkedStateValue>
  Checkbox 1
</Checkbox>;
```

<!-- eoContent -->

## Links

- [Storybook Showcase](https://paprika.highbond.com/?path=/story/forms-checkbox--showcase)
- [GitHub source code](https://github.com/acl-services/paprika/tree/master/packages/Checkbox/src)
- [Create GitHub issue](https://github.com/acl-services/paprika/issues/new?label=[]&title=@paprika/checkbox%20[help]:%20your%20short%20description&body=%0A%23%20Help%20wanted%0A%0A%23%23%20Please%20write%20your%20question.%0A*A%20clear%20and%20concise%20description%20of%20what%20the%20question%20is*%0A%0A%23%23%20Additional%20context%0A*Add%20any%20other%20context%20or%20screenshots%20about%20your%20question%20here.*%0A)
- [CHANGELOG](https://github.com/acl-services/paprika/tree/master/packages/Checkbox/CHANGELOG.md)