# @availity/mui-checkbox

> Availity MUI Checkbox component to be used with @availity/element design system.

[![Version](https://img.shields.io/npm/v/@availity/mui-checkbox.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-checkbox)
[![NPM Downloads](https://img.shields.io/npm/dt/@availity/mui-checkbox.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-checkbox)
[![Dependency Status](https://img.shields.io/librariesio/release/npm/@availity/mui-checkbox?style=for-the-badge)](https://github.com/Availity/element/blob/main/packages/checkbox/package.json)

## Documentation

This package extends the MUI Checkbox component: [MUI Checkbox Docs](https://mui.com/components/checkbox/)

Live demo and documentation in our [Storybook](https://availity.github.io/element/?path=/docs/form-components-uncontrolled-formutils-checkbox-readme--docs)

Availity standards for design and usage can be found in the [Availity Design Guide](https://design.availity.com/2e36e50c7)

## Installation

### Import Through @availity/element (Recommended)

#### NPM

```bash
npm install @availity/element
```

#### Yarn

```bash
yarn add @availity/element
```

### Direct Import

#### NPM

_This package has a few peer dependencies. Add `@mui/material` & `@emotion/react` to your project if not already installed._

```bash
npm install @availity/mui-checkbox
```

#### Yarn

```bash
yarn add @availity/mui-checkbox
```

### Usage

#### Import through @availity/element

```tsx
import { Checkbox } from '@availity/element';
```

#### Direct import

```tsx
import { Checkbox } from '@availity/mui-checkbox';
```