245e5c9a69
* added tool to generate spec files for React components * use typedoc for missing descriptions and types * improvements and fixes * improvements * added doc comments for half of the components * add custom resolver + more doc comments * added all tsdocs * general improvements * add specs to UI docs * added github action * remove unnecessary api route * Added readme for react-docs-generator * remove comment * Update packages/design-system/ui/src/components/currency-input/currency-input.tsx Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com> * remove description of aria fields + add generate script --------- Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
46 lines
606 B
Plaintext
46 lines
606 B
Plaintext
---
|
|
title: "Checkbox"
|
|
description: "A control that allows the user to toggle between checked and not checked."
|
|
component: true
|
|
---
|
|
|
|
<ComponentExample name="checkbox-demo" />
|
|
|
|
## Usage
|
|
|
|
---
|
|
|
|
```tsx
|
|
import { Checkbox } from "@medusajs/ui"
|
|
```
|
|
|
|
```tsx
|
|
<Checkbox />
|
|
```
|
|
|
|
## API Reference
|
|
|
|
---
|
|
|
|
<ComponentReference mainComponent="Checkbox" />
|
|
|
|
## Examples
|
|
|
|
---
|
|
|
|
### Default
|
|
|
|
<ComponentExample name="checkbox-default" />
|
|
|
|
### Checked
|
|
|
|
<ComponentExample name="checkbox-checked" />
|
|
|
|
### Disabled
|
|
|
|
<ComponentExample name="checkbox-disabled" />
|
|
|
|
### Indeterminate
|
|
|
|
<ComponentExample name="checkbox-indeterminate" />
|