@s-ui/react-atom-checkbox/README.md

AtomCheckbox is a component that displays an input checkbox w/ its expected behavior

# AtomCheckbox

AtomCheckbox is a component that displays an input checkbox w/ its expected behavior

[![documentation](https://img.shields.io/badge/read%20the%20doc-black?logo=readthedocs)](https://sui-components.vercel.app/workbench/atom/checkbox/)
[![issue](https://img.shields.io/badge/report%20a%20bug-black?logo=openbugbounty&logoColor=red)](https://github.com/SUI-Components/sui-components/issues/new?&projects=4&template=bug-report.yml&assignees=&template=report-a-bug.yml&title=🪲+&labels=bug,component,atom,checkbox)
[![npm](https://img.shields.io/npm/dt/%40s-ui/react-atom-checkbox?logo=npm&labelColor=black)](https://www.npmjs.com/package/@s-ui/react-atom-checkbox)

[![Issues open](https://img.shields.io/github/issues-search/SUI-Components/sui-components?query=is%3Aopen%20label%3Acomponent%20label%3Acheckbox&logo=openbugbounty&logoColor=red&label=issues%20open&color=red)](https://github.com/SUI-Components/sui-components/issues?q=is%3Aopen+label%3Acomponent+label%3Acheckbox)
[![NPM](https://img.shields.io/npm/l/%40s-ui%2Freact-atom-checkbox)](https://github.com/SUI-Components/sui-components/blob/main/components/atom/checkbox/LICENSE.md)

## Installation

```sh
$ npm install @s-ui/react-atom-checkbox --save
```

## Usage

```js
import AtomCheckbox from '@s-ui/react-atom-checkbox'
```

### Basic usage

```js
<AtomCheckbox />
```

### Checked

```js
<AtomCheckbox checked />
```

### Disabled

```js
<AtomCheckbox disabled />
```

### w/ onChange handler

```js
<AtomCheckbox onChange={console.log} />
```

> **Find full description and more examples in the [demo page](/workbench/atom/checkbox).**