snapshot of https://github.com/shadcn-ui/ui.git (main, 2026-09-15; blobs > 131072B omitted)
This commit is contained in:
93
apps/v4/content/docs/components/base/toggle.mdx
Normal file
93
apps/v4/content/docs/components/base/toggle.mdx
Normal file
@@ -0,0 +1,93 @@
|
||||
---
|
||||
title: Toggle
|
||||
description: A two-state button that can be either on or off.
|
||||
base: base
|
||||
component: true
|
||||
links:
|
||||
doc: https://base-ui.com/react/components/toggle
|
||||
api: https://base-ui.com/react/components/toggle#api-reference
|
||||
---
|
||||
|
||||
<ComponentPreview styleName="base-nova" name="toggle-demo" />
|
||||
|
||||
## Installation
|
||||
|
||||
<CodeTabs>
|
||||
|
||||
<TabsList>
|
||||
<TabsTrigger value="cli">Command</TabsTrigger>
|
||||
<TabsTrigger value="manual">Manual</TabsTrigger>
|
||||
</TabsList>
|
||||
<TabsContent value="cli">
|
||||
|
||||
```bash
|
||||
npx shadcn@latest add toggle
|
||||
```
|
||||
|
||||
</TabsContent>
|
||||
|
||||
<TabsContent value="manual">
|
||||
|
||||
<Steps className="mb-0 pt-2">
|
||||
|
||||
<Step>Install the following dependencies:</Step>
|
||||
|
||||
```bash
|
||||
npm install @base-ui/react
|
||||
```
|
||||
|
||||
<Step>Copy and paste the following code into your project.</Step>
|
||||
|
||||
<ComponentSource
|
||||
name="toggle"
|
||||
title="components/ui/toggle.tsx"
|
||||
styleName="base-nova"
|
||||
/>
|
||||
|
||||
<Step>Update the import paths to match your project setup.</Step>
|
||||
|
||||
</Steps>
|
||||
|
||||
</TabsContent>
|
||||
|
||||
</CodeTabs>
|
||||
|
||||
## Usage
|
||||
|
||||
```tsx
|
||||
import { Toggle } from "@/components/ui/toggle"
|
||||
```
|
||||
|
||||
```tsx
|
||||
<Toggle>Toggle</Toggle>
|
||||
```
|
||||
|
||||
## Outline
|
||||
|
||||
Use `variant="outline"` for an outline style.
|
||||
|
||||
<ComponentPreview styleName="base-nova" name="toggle-outline" />
|
||||
|
||||
## With Text
|
||||
|
||||
<ComponentPreview styleName="base-nova" name="toggle-text" />
|
||||
|
||||
## Size
|
||||
|
||||
Use the `size` prop to change the size of the toggle.
|
||||
|
||||
<ComponentPreview styleName="base-nova" name="toggle-sizes" />
|
||||
|
||||
## Disabled
|
||||
|
||||
<ComponentPreview styleName="base-nova" name="toggle-disabled" />
|
||||
|
||||
## RTL
|
||||
|
||||
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
||||
|
||||
<ComponentPreview styleName="base-nova" name="toggle-rtl" direction="rtl" />
|
||||
|
||||
## API Reference
|
||||
|
||||
See the [Base UI Toggle](https://base-ui.com/react/components/toggle#api-reference) documentation.
|
||||
Reference in New Issue
Block a user