# Toggle

shadcn toggle as a pixel button that stays sunk while pressed.

Source: https://www.ui95.dev/ui/toggle

## Examples

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

import type { ShowcaseDemo } from "../types"

type ToggleState = {
  label: string
  variant: "default" | "outline"
  size: "default" | "sm" | "lg"
  isPressed?: boolean
  isDisabled?: boolean
  isInvalid?: boolean
}

const STATES: readonly ToggleState[] = [
  { label: "default", variant: "default", size: "default" },
  { label: "default pressed", variant: "default", size: "default", isPressed: true },
  { label: "outline", variant: "outline", size: "default" },
  { label: "outline pressed", variant: "outline", size: "default", isPressed: true },
  { label: "sm", variant: "default", size: "sm" },
  { label: "lg", variant: "default", size: "lg" },
  { label: "disabled", variant: "default", size: "default", isDisabled: true },
  { label: "invalid", variant: "default", size: "default", isInvalid: true },
]

export const demo: ShowcaseDemo = {
  span: "single",
  variants: STATES.map((state) => ({
    label: state.label,
    render: () => (
      <Toggle
        variant={state.variant}
        size={state.size}
        defaultPressed={state.isPressed}
        disabled={state.isDisabled}
        aria-invalid={state.isInvalid}
      >
        Bold
      </Toggle>
    ),
  })),
}
```

## Installation

```bash
npx shadcn@latest add https://www.ui95.dev/r/toggle.json
```

Run it in a Radix shadcn project that already has the UI95 theme.

Dependencies:

```bash
npm install class-variance-authority cn radix-ui
```

`components/ui/toggle.tsx`

```tsx
"use client"

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

const toggleVariants = cva(
  "group/toggle inline-flex items-center justify-center gap-1 pixel-border bg-clip-padding font-pixel text-[16px] leading-none whitespace-nowrap uppercase outline-none select-none disabled:pointer-events-none disabled:text-muted-foreground disabled:dither-50 aria-invalid:border-dashed aria-invalid:border-destructive data-[state=on]:bg-muted data-[state=on]:text-foreground data-[state=on]:offset-shadow-none data-[state=on]:bevel-sunken aria-pressed:bg-muted [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
  {
    variants: {
      variant: {
        default: "border-transparent bg-transparent hover:bg-muted bevel-raised",
        outline: "border-border bg-transparent hover:bg-muted",
      },
      size: {
        default:
          "h-8 min-w-8 px-2.5 has-data-[icon=inline-end]:pr-2 has-data-[icon=inline-start]:pl-2",
        sm: "h-7 min-w-7 px-2 text-sm has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5 [&_svg:not([class*='size-'])]:size-3.5",
        lg: "h-10 min-w-10 px-3 has-data-[icon=inline-end]:pr-2 has-data-[icon=inline-start]:pl-2",
      },
    },
    defaultVariants: {
      variant: "default",
      size: "default",
    },
  }
)

function Toggle({
  className,
  variant = "default",
  size = "default",
  ...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 }
```

## API reference

### Toggle

| Prop | Type | Default |
| --- | --- | --- |
| `variant` | `"default" \| "outline"` | `"default"` |
| `size` | `"sm" \| "lg" \| "default"` | `"default"` |

## Used by

- [toggle-group](https://www.ui95.dev/ui/toggle-group)

## Sounds

- `toggle.on`
- `toggle.off`
