vueless/ui.form-checkbox/storybook/docs.mdx

Vue Styleless UI Component Library, powered by Tailwind CSS.

import { Markdown, Meta, Title, Subtitle, Description, Primary, Controls, Stories, Source } from "@storybook/addon-docs/blocks";
import { getSource } from "../../utils/storybook";

import * as stories from "./stories";
import defaultConfig from "../config?raw"

<Meta of={stories} />
<Title of={stories} />
<Subtitle of={stories} />
<Description of={stories} />
<Primary of={stories}  />
<Controls of={stories.Default} />
<Stories of={stories} />

## Option meta keys
Keys you may/have to provide to the component in an option object.

<Markdown>
{`
|  Key name         | Description                            | Type                                   |
| ------------------| ---------------------------------------| ---------------------------------------|
| value             | Native value attribute                 | Boolean, String, Number, Array, Object |
| trueValue         | Own value for checkbox checked state   | Boolean, String, Number, Array, Object |
| falseValue        | Own value for checkbox unchecked state | Boolean, String, Number, Array, Object |
| label             | Option label                           | String                                 |
| icon              | Option icon                            | String                                 |
| description       | Option description                     | Number                                 |   
`}
</Markdown>

## Default config
<Source code={getSource(defaultConfig)} language="jsx" dark />