- Docs
- Switch
Switch
A switch allows a user to turn a setting on or off.
Preview
Code
Loading...
Installation
Manual
Copy and paste the following code into your project.
"use client"
import * as React from "react"
import { Switch, SwitchProps } from "react-aria-components"
import { cn } from "@/lib/utils"
const _Switch = ({ children, className, ...props }: SwitchProps) => (
<Switch
className={(values) =>
cn(
"group inline-flex items-center gap-2 text-sm font-medium leading-none data-[disabled]:cursor-not-allowed data-[disabled]:opacity-70",
typeof className === "function" ? className(values) : className
)
}
{...props}
>
{(values) => (
<>
<div className="h-[24px] w-[44px] shrink-0 cursor-pointer rounded-full border-2 border-transparent bg-input transition-colors group-data-[selected]:bg-primary group-data-[disabled]:opacity-50 group-data-[focus-visible]:outline-none group-data-[focus-visible]:ring-2 group-data-[focus-visible]:ring-ring group-data-[focus-visible]:ring-offset-2 group-data-[focus-visible]:ring-offset-background">
<div
className={cn(
"pointer-events-none block h-5 w-5 translate-x-0 rounded-full bg-background shadow-lg ring-0 transition-transform group-data-[selected]:translate-x-5"
)}
/>
</div>
{typeof children === "function" ? children(values) : children}
</>
)}
</Switch>
)
export { _Switch as Switch }
Update the import paths to match your project setup.
Usage
Basic
Preview
Code
Loading...
Disabled
Preview
Code
Loading...
Readonly
Preview
Code
Loading...
On This Page