import { Meta, Story, ArgsTable, Canvas } from '@storybook/addon-docs/blocks';
import { CheckBox } from './check-box.component';
import {
  FlowPropsTable,
  ExternalReferenceLink,
} from '../../../../utils/storybook/docs-support';

<Meta title="Forms|CheckBox" component={CheckBox} />

# CheckBox

- [Form Input Accessibility
  Tips](/?path=/story/components-inputs-accessibility-tips--page)

CheckBox creates a styled check box with some children. The text of the children is used as the label.

## Stories

### Interactive Demo

<Canvas>
  <Story id="components-inputs-checkbox--demo" />
</Canvas>

### Control on the Right

<Canvas>
  <Story id="components-inputs-checkbox--direction-right" />
</Canvas>

### Custom Children

<Canvas>
  <Story id="components-inputs-checkbox--custom-children" />
</Canvas>

## Supported Property Mixins

Spacing:

<Canvas>
  <Story id="components-inputs-checkbox--mixins-spacing" />
</Canvas>

Stackee:

<Canvas>
  <Story id="components-inputs-checkbox--mixins-stackee" />
</Canvas>

## Props

<FlowPropsTable ofComponent={CheckBox} />

## External Reference

<ExternalReferenceLink
  src="https://www.figma.com/file/r5zKXblbSt0b869OEcOWXu/Patchwork-Web?node-id=637%3A66"
  type="figma"
/>
<ExternalReferenceLink
  src="https://github.com/wealthsimple/patchwork/tree/master/core/forms/check-box"
  type="github"
/>
