d1a1135328
* docs: create a new UI docs project (#13233) * docs: create a new UI docs project * fix installation errors * docs: migrate UI docs content to new project (#13241) * Fix content * added examples for some components * finish adding examples * lint fix * fix build errors * delete empty files * path fixes + refactor * fix build error
46 lines
809 B
Plaintext
46 lines
809 B
Plaintext
import { ComponentExample } from "@/components/ComponentExample"
|
|
import { ComponentReference } from "@/components/ComponentReference"
|
|
|
|
export const metadata = {
|
|
title: `Switch`,
|
|
}
|
|
|
|
# {metadata.title}
|
|
|
|
A component for toggling between two states, typically on and off. It's essentially a checkbox in the form of a switch.
|
|
|
|
In this guide, you'll learn how to use the Switch component.
|
|
|
|
<ComponentExample name="switch-demo" />
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Switch } from "@medusajs/ui"
|
|
```
|
|
|
|
```tsx
|
|
<Switch />
|
|
```
|
|
|
|
---
|
|
|
|
## API Reference
|
|
|
|
<ComponentReference mainComponent="Switch" />
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
### Switch Sizes
|
|
|
|
<ComponentExample name="switch-all-sizes" />
|
|
|
|
### Controlled Switch
|
|
|
|
<ComponentExample name="switch-controlled" hideFeedback />
|
|
|
|
### Disabled Switch
|
|
|
|
<ComponentExample name="switch-disabled" /> |