mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-15 20:01:35 +00:00
94 lines
1.6 KiB
Plaintext
94 lines
1.6 KiB
Plaintext
---
|
|
title: Toggle
|
|
description: A two-state button that can be either on or off.
|
|
component: true
|
|
links:
|
|
doc: 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" description="A toggle component." />
|
|
|
|
## Installation
|
|
|
|
<Tabs defaultValue="cli">
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">CLI</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add toggle
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps>
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install @radix-ui/react-toggle
|
|
```
|
|
|
|
<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" description="A toggle component." />
|
|
|
|
### Outline
|
|
|
|
<ComponentPreview
|
|
name="toggle-outline"
|
|
description="A toggle component using the outline variant."
|
|
/>
|
|
|
|
### With Text
|
|
|
|
<ComponentPreview
|
|
name="toggle-with-text"
|
|
description="A toggle component with text."
|
|
/>
|
|
|
|
### Small
|
|
|
|
<ComponentPreview name="toggle-sm" description="A small toggle component." />
|
|
|
|
### Large
|
|
|
|
<ComponentPreview name="toggle-lg" description="A large toggle component." />
|
|
|
|
### Disabled
|
|
|
|
<ComponentPreview
|
|
name="toggle-disabled"
|
|
description="A disabled toggle component."
|
|
/>
|