---
title: Toggle
description: A two-state button that can be either on or off.
links:
  doc: https://base-ui.com/react/components/toggle
  api: https://base-ui.com/react/components/toggle#api-reference
---

```tsx
'use client';

import { Toggle } from '@/components/ui/toggle';
import { Bold } from 'lucide-react';

export function ToggleDefault() {
  return (
    <Toggle aria-label='Toggle bold'>
      <Bold />
    </Toggle>
  );
}
```

## Installation

```bash
npx shadcn@latest add @fab-ui/toggle
```

**Install the following dependencies:**

```bash
npm install @base-ui/react
```

**Copy and paste the following code into your project.**

```tsx
'use client';

import { Toggle as TogglePrimitive } from '@base-ui/react/toggle';
import { cva, type VariantProps } from 'class-variance-authority';

import { cn } from '@/lib/utils';

const toggleVariants = cva(
  "hover:text-foreground aria-pressed:bg-muted focus-visible:border-ring focus-visible:ring-ring/50 aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive data-[state=on]:bg-muted gap-1 rounded-lg text-sm font-medium transition-all [&_svg:not([class*='size-'])]:size-4 group/toggle hover:bg-muted inline-flex items-center justify-center whitespace-nowrap outline-none focus-visible:ring-[3px] disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0",
  {
    variants: {
      variant: {
        default: 'bg-transparent',
        outline: 'border-input hover:bg-muted border bg-transparent',
      },
      size: {
        default: 'h-8 min-w-8 px-2',
        sm: 'h-7 min-w-7 rounded-[min(var(--radius-md),12px)] px-1.5 text-[0.8rem]',
        lg: 'h-9 min-w-9 px-2.5',
      },
    },
    defaultVariants: {
      variant: 'default',
      size: 'default',
    },
  }
);

function Toggle({
  className,
  variant = 'default',
  size = 'default',
  ...props
}: TogglePrimitive.Props & VariantProps<typeof toggleVariants>) {
  return (
    <TogglePrimitive
      data-slot='toggle'
      className={cn(toggleVariants({ variant, size, className }))}
      {...props}
    />
  );
}

export { Toggle, toggleVariants };
```

**Update the import paths to match your project setup.**

## Usage

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

```tsx
<Toggle aria-label="Toggle bold">
  <Bold />
</Toggle>
```

## Examples

### Outline

```tsx
'use client';

import { Toggle } from '@/components/ui/toggle';
import { Italic } from 'lucide-react';

export function ToggleOutline() {
  return (
    <Toggle variant='outline' aria-label='Toggle italic'>
      <Italic />
    </Toggle>
  );
}
```

### With Text

```tsx
'use client';

import { Toggle } from '@/components/ui/toggle';
import { Italic } from 'lucide-react';

export function ToggleWithText() {
  return (
    <Toggle aria-label='Toggle italic'>
      <Italic />
      Italic
    </Toggle>
  );
}
```