Toggle

Displays a toggle built on the Base UI Toggle primitive: a two-state button for options like bold, italic, or mute.

TSX
import { Toggle } from "@/components/ui/toggle";

export default function ToggleDemo() {
  return (
    <Toggle variant="outline" aria-label="Toggle bold">
      <span className="font-bold">B</span>
    </Toggle>
  );
}

Installation

Bash
npx shadcn@latest add @sevenui/togglepnpm dlx shadcn@latest add @sevenui/toggleyarn dlx shadcn@latest add @sevenui/togglebunx --bun shadcn@latest add @sevenui/toggle

Usage

TSX
import { Toggle } from "@/components/ui/toggle";

<Toggle variant="outline" aria-label="Toggle bold">
  <span className="font-bold">B</span>
</Toggle>;

Examples

Variants

TSX
import { Toggle } from "@/components/ui/toggle";

<Toggle variant="default">Default</Toggle>
<Toggle variant="outline">Outline</Toggle>

Sizes

TSX
import { Toggle } from "@/components/ui/toggle";

<Toggle size="sm">Small</Toggle>
<Toggle size="default">Default</Toggle>
<Toggle size="lg">Large</Toggle>

Examples

Variants and sizes

TSX
import { ItalicIcon } from "lucide-react";

import { Toggle } from "@/components/ui/toggle";

export default function ToggleVariants() {
  return (
    <div className="flex flex-col gap-4">
      <div className="flex items-center gap-2">
        <Toggle size="sm" aria-label="Toggle italic (small)">
          <ItalicIcon />
        </Toggle>
        <Toggle aria-label="Toggle italic">
          <ItalicIcon />
        </Toggle>
        <Toggle size="lg" aria-label="Toggle italic (large)">
          <ItalicIcon />
        </Toggle>
      </div>
      <div className="flex items-center gap-2">
        <Toggle variant="outline" size="sm" aria-label="Toggle italic (small)">
          <ItalicIcon />
        </Toggle>
        <Toggle variant="outline" aria-label="Toggle italic">
          <ItalicIcon />
        </Toggle>
        <Toggle variant="outline" size="lg" aria-label="Toggle italic (large)">
          <ItalicIcon />
        </Toggle>
      </div>
    </div>
  );
}

API reference

Toggle

Extends the Base UI Toggle primitive — all its props apply. Give icon-only toggles an aria-label.

Prop	Type	Default
`variant`	`"default" \| "outline"`	`"default"`
`size`	`"default" \| "sm" \| "lg"`	`"default"`
`pressed` / `defaultPressed`	`boolean`	`false`
`onPressedChange`	`(pressed: boolean) => void`	—
`disabled`	`boolean`	`false`

toggleVariants is also exported for styling custom elements.