# Switch

A controlled toggle built on Radix Switch with keyboard support, checked/unchecked styling, and a disabled state.

- Category: Forms
- License: MIT
- Page: https://www.saasuji.com/components/switch
- Install: npx shadcn@latest add https://www.saasuji.com/r/switch.json

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| checked | `boolean` | — | Controlled checked state of the switch. |
| defaultChecked | `boolean` | `false` | Initial checked state for an uncontrolled switch. |
| onCheckedChange | `(checked: boolean) => void` | — | Called when the checked state changes. |
| disabled | `boolean` | `false` | Disables interaction and reduces opacity. |
| required | `boolean` | `false` | Marks the switch as required for form submission. |
| name | `string` | — | Name of the hidden input submitted with a form. |
| value | `string` | `"on"` | Value submitted with the form when the switch is checked. |
| className | `string` | — | Additional classes merged onto the switch root. |

## Source

```tsx
"use client"

import * as React from "react"
import * as SwitchPrimitives from "@radix-ui/react-switch"

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

const Switch = React.forwardRef<
    React.ElementRef<typeof SwitchPrimitives.Root>,
    React.ComponentPropsWithoutRef<typeof SwitchPrimitives.Root>
>(({ className, ...props }, ref) => (
    <SwitchPrimitives.Root
        className={cn(
            "peer inline-flex h-[24px] w-[44px] shrink-0 cursor-pointer items-center rounded-full border-2 border-transparent transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 focus-visible:ring-offset-background disabled:cursor-not-allowed disabled:opacity-50 data-[state=checked]:bg-primary data-[state=unchecked]:bg-input",
            className
        )}
        {...props}
        ref={ref}
    >
        <SwitchPrimitives.Thumb
            className={cn(
                "pointer-events-none block h-5 w-5 rounded-full bg-background shadow-lg ring-0 transition-transform data-[state=checked]:translate-x-5 data-[state=unchecked]:translate-x-0"
            )}
        />
    </SwitchPrimitives.Root>
))
Switch.displayName = SwitchPrimitives.Root.displayName

export { Switch }

```