# Toggle

A two-state button built on Radix Toggle with default and outline variants, three sizes, controlled or uncontrolled pressed state, and a disabled state.

- Category: Overlays & Navigation
- License: MIT
- Page: https://www.saasuji.com/components/toggle
- Install: npx shadcn@latest add https://www.saasuji.com/r/toggle.json

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| variant | `"default" | "outline"` | `"default"` | Visual style of the toggle. |
| size | `"default" | "sm" | "lg"` | `"default"` | Height, minimum width, and padding scale. |
| pressed | `boolean` | — | Controlled pressed state of the toggle. |
| defaultPressed | `boolean` | `false` | Pressed state on first render for an uncontrolled toggle. |
| onPressedChange | `(pressed: boolean) => void` | — | Called when the pressed state changes. |
| disabled | `boolean` | `false` | Disables interaction and reduces opacity. |
| asChild | `boolean` | `false` | Renders the toggle as its child element instead of the default button. |
| className | `string` | — | Additional classes merged onto the toggle. |
| children | `React.ReactNode` | — | Text label, icon, or both. |
| toggleVariants | `(props?: { variant?: "default" | "outline" | null; size?: "default" | "sm" | "lg" | null; class?: ClassValue }) => string` | — | Exported class-variance-authority helper that composes the toggle class names. |
| ...props | `React.ComponentProps<typeof TogglePrimitive.Root>` | — | All remaining Radix Toggle and native button props are forwarded (aria-label, name, value, …). |

## Source

```tsx
"use client"

import * as React from "react"
import { cva, type VariantProps } from "class-variance-authority"
import { Toggle as TogglePrimitive } from "radix-ui"

import { cn } from "@/lib/utils"

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

function Toggle({
  className,
  variant,
  size,
  ...props
}: React.ComponentProps<typeof TogglePrimitive.Root> &
  VariantProps<typeof toggleVariants>) {
  return (
    <TogglePrimitive.Root
      data-slot="toggle"
      className={cn(toggleVariants({ variant, size, className }))}
      {...props}
    />
  )
}

export { Toggle, toggleVariants }

```