@umbraco-ui/uui-checkbox/README.md

Umbraco checkbox custom element, toggles between checked and uncheck

# uui-checkbox

[![npm](https://img.shields.io/npm/v/@umbraco-ui/uui-checkbox?logoColor=%231B264F)](https://www.npmjs.com/package/@umbraco-ui/uui-checkbox)

### See it in action

Preview the component on [Storybook](https://uui.umbraco.com/?path=/docs/uui-checkbox--docs)

## Installation

### ES imports

```zsh
npm i @umbraco-ui/uui-checkbox
```

Import the registration of `<uui-checkbox>` via:

```javascript
import '@umbraco-ui/uui-checkbox';
```

When looking to leverage the `UUICheckboxElement` base class as a type and/or for extension purposes, do so via:

```javascript
import { UUICheckboxElement } from '@umbraco-ui/uui-checkbox';
```

## Usage

```html
<uui-checkbox label="Checkbox" value="bike"></uui-checkbox>
```