Docs
Toggle Button
Toggle Button
A toggle button allows a user to toggle a selection on or off, for example switching between two states or modes.
Installation
Install the following dependencies:
Copy and paste the following code into your project.
"use client"
import * as React from "react"
import { cva, type VariantProps } from "class-variance-authority"
import { ToggleButton, type ToggleButtonProps } from "react-aria-components"
import { cn } from "@/lib/utils"
const toggleVariants = cva(
"inline-flex items-center justify-center rounded-md text-sm font-medium ring-offset-background transition-colors data-[disabled]:pointer-events-none data-[hovered]:bg-muted data-[selected]:bg-accent data-[hovered]:text-muted-foreground data-[selected]:text-accent-foreground data-[disabled]:opacity-50 data-[focus-visible]:outline-none data-[focus-visible]:ring-2 data-[focus-visible]:ring-ring data-[focus-visible]:ring-offset-2",
{
variants: {
variant: {
default: "bg-transparent",
outline:
"border border-input bg-transparent data-[hovered]:bg-accent data-[hovered]:text-accent-foreground",
},
size: {
default: "h-10 px-3",
sm: "h-9 px-2.5",
lg: "h-11 px-5",
},
},
defaultVariants: {
variant: "default",
size: "default",
},
}
)
export interface _ToggleProps
extends ToggleButtonProps,
VariantProps<typeof toggleVariants> {}
const Toggle = ({ className, variant, size, ...props }: _ToggleProps) => (
<ToggleButton
className={(values) =>
cn(
toggleVariants({
variant,
size,
className:
typeof className === "function" ? className(values) : className,
})
)
}
{...props}
/>
)
export { Toggle, toggleVariants }
Update the import paths to match your project setup.
Usage
import { Toggle } from "@/components/ui/toggle"
<Toggle>Toggle</Toggle>