---
title: Toggle
description: A two-state button that can be toggled on or off.

links:
  doc: https://base-ui.com/react/components/toggle#api-reference
---

## Preview

<ComponentPreview name="p-toggle-1" />

## Installation

<CodeTabs>

<TabsList>
  <TabsTab value="cli">CLI</TabsTab>
  <TabsTab value="manual">Manual</TabsTab>
</TabsList>

<TabsPanel value="cli">

```bash
npx @olyx/cli@latest add toggle
```

</TabsPanel>

<TabsPanel value="manual">

<Steps>

<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" />

<Step>Update the import paths to match your project setup.</Step>

</Steps>

</TabsPanel>

</CodeTabs>

## Usage

```tsx
import { Toggle } from "@/components/ui/toggle"
```

```tsx
<Toggle>Toggle</Toggle>
```

## API Reference

### Toggle

Styled wrapper for `Toggle.Root` from Base UI.

| Prop      | Type                       | Default     |
| --------- | -------------------------- | ----------- |
| `variant` | `"primary" \| "ghost"`     | `"primary"` |
| `size`    | `"sm" \| "md" \| "lg"`    | `"md"`      |

All props from [Base UI Toggle](https://base-ui.com/react/components/toggle#api-reference) are also supported.

## Examples

### Ghost

<ComponentPreview name="p-toggle-2" />

### With Icon

<ComponentPreview name="p-toggle-3" />

### Small

<ComponentPreview name="p-toggle-4" />

### Large

<ComponentPreview name="p-toggle-5" />

### Disabled

<ComponentPreview name="p-toggle-6" />