Toggle
A two-state button that can be either on or off.
Installation
Install the following dependencies:
pnpm add @radix-ui/react-toggle
Copy and paste the following code into your project.
"use client";
import * as React from "react";
import * as TogglePrimitive from "@radix-ui/react-toggle";
import { cva, type VariantProps } from "class-variance-authority";
import { cn } from "~/utils/tailwind";
const toggleVariants = cva(
cn(
"inline-flex items-center justify-center rounded-1.5 text-3.5 font-medium ring-offset-background transition-colors",
"hover:bg-muted hover:text-muted-foreground",
"focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring focus-visible:ring-offset-1",
"disabled:pointer-events-none disabled:opacity-50",
"data-[state=on]:bg-accent data-[state=on]:text-accent-foreground",
),
{
variants: {
variant: {
default: "bg-transparent",
outline:
"border border-input bg-transparent hover:bg-accent hover:text-accent-foreground",
},
size: {
sm: "h-8 px-2",
default: "h-9 px-2.5",
lg: "h-10 px-3",
},
},
defaultVariants: {
variant: "default",
size: "default",
},
},
);
const Toggle = React.forwardRef<
React.ElementRef<typeof TogglePrimitive.Root>,
React.ComponentPropsWithoutRef<typeof TogglePrimitive.Root> &
VariantProps<typeof toggleVariants>
>(({ className, variant, size, ...props }, ref) => (
<TogglePrimitive.Root
ref={ref}
className={cn(toggleVariants({ variant, size, className }))}
{...props}
/>
));
Toggle.displayName = TogglePrimitive.Root.displayName;
export { Toggle, toggleVariants };
Update the import paths to match your project setup.
Usage
import { Toggle } from "@/components/ui/Toggle";
<Toggle>Toggle</Toggle>;