mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-25 21:56:08 +00:00
79 lines
1.2 KiB
Plaintext
79 lines
1.2 KiB
Plaintext
---
|
|
title: Toggle
|
|
description: A two-state button that can be either on or off.
|
|
component: true
|
|
radix:
|
|
link: https://www.radix-ui.com/docs/primitives/components/toggle
|
|
api: https://www.radix-ui.com/docs/primitives/components/toggle#api-reference
|
|
---
|
|
|
|
<ComponentPreview name="toggle-demo" />
|
|
|
|
## Installation
|
|
|
|
<Tabs defaultValue="cli">
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">CLI</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn-ui@latest add toggle
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps>
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource name="toggle" />
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</Tabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Toggle } from "@/components/ui/toggle"
|
|
```
|
|
|
|
```tsx
|
|
<Toggle>Toggle</Toggle>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Default
|
|
|
|
<ComponentPreview name="toggle-demo" />
|
|
|
|
### Outline
|
|
|
|
<ComponentPreview name="toggle-outline" />
|
|
|
|
### With Text
|
|
|
|
<ComponentPreview name="toggle-with-text" />
|
|
|
|
### Small
|
|
|
|
<ComponentPreview name="toggle-sm" />
|
|
|
|
### Large
|
|
|
|
<ComponentPreview name="toggle-lg" />
|
|
|
|
### Disabled
|
|
|
|
<ComponentPreview name="toggle-disabled" />
|