102 lines
2.2 KiB
Plaintext
102 lines
2.2 KiB
Plaintext
---
|
|
title: Switch
|
|
description: A control that allows the user to toggle between checked and not checked.
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/switch
|
|
api: https://base-ui.com/react/components/switch#api-reference
|
|
---
|
|
|
|
<ComponentPreview styleName="base-nova" name="switch-demo" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add switch
|
|
```
|
|
|
|
</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="switch"
|
|
title="components/ui/switch.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Switch } from "@/components/ui/switch"
|
|
```
|
|
|
|
```tsx
|
|
<Switch />
|
|
```
|
|
|
|
## Description
|
|
|
|
<ComponentPreview styleName="base-nova" name="switch-description" />
|
|
|
|
## Choice Card
|
|
|
|
Card-style selection where `FieldLabel` wraps the entire `Field` for a clickable card pattern.
|
|
|
|
<ComponentPreview styleName="base-nova" name="switch-choice-card" />
|
|
|
|
## Disabled
|
|
|
|
Add the `disabled` prop to the `Switch` component to disable the switch. Add the `data-disabled` prop to the `Field` component for styling.
|
|
|
|
<ComponentPreview styleName="base-nova" name="switch-disabled" />
|
|
|
|
## Invalid
|
|
|
|
Add the `aria-invalid` prop to the `Switch` component to indicate an invalid state. Add the `data-invalid` prop to the `Field` component for styling.
|
|
|
|
<ComponentPreview styleName="base-nova" name="switch-invalid" />
|
|
|
|
## Size
|
|
|
|
Use the `size` prop to change the size of the switch.
|
|
|
|
<ComponentPreview styleName="base-nova" name="switch-sizes" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="base-nova" name="switch-rtl" direction="rtl" />
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI Switch](https://base-ui.com/react/components/switch#api-reference) documentation.
|