Toggle
Two-state toggle button for React UIs: bold, italic, or grid vs list view. Accessible Radix primitive with variants and sizes. Install via the shadcn CLI.
What it is & when to use
Toggle is a two-state button built on Radix UI's Toggle primitive. It flips between on and off, exposing the pressed state through data-[state=on] styling so you can theme it with Tailwind. Reach for it when a single control switches one option on or off — bold text, grid versus list view, or mute audio. It ships with default and outline variants plus small, default, and large sizes. For a set of related toggles, use Toggle Group instead.
Browse all CorePreview
Switch between light and dark to inspect the embedded Storybook preview.
Installation
pnpm dlx shadcn@latest add https://ui.vllnt.com/r/toggle.jsonStorybook
Explore all variants, controls, and accessibility checks in the interactive Storybook playground.
View in Storybook4 stories available:
Code
"use client";
import * as TogglePrimitive from "@radix-ui/react-toggle";
import { cva, type VariantProps } from "class-variance-authority";
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 hover:bg-muted hover:text-muted-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 data-[state=on]:bg-accent data-[state=on]:text-accent-foreground [&_svg]:pointer-events-none [&_svg]:size-4 [&_svg]:shrink-0",
{
defaultVariants: {
size: "default",
variant: "default",
},
variants: {
size: {
default: "h-10 px-3 min-w-10",
lg: "h-11 px-5 min-w-11",
sm: "h-9 px-2.5 min-w-9",
},
variant: {
default: "bg-transparent",
outline:
"border border-input bg-transparent hover:bg-accent hover:text-accent-foreground",
},
},
},
);
const Toggle = ({
className,
ref,
size,
variant,
...props
}: React.ComponentPropsWithoutRef<typeof TogglePrimitive.Root> &
VariantProps<typeof toggleVariants> & {
ref?: React.Ref<React.ComponentRef<typeof TogglePrimitive.Root>>;
}) => (
<TogglePrimitive.Root
className={cn(toggleVariants({ className, size, variant }))}
ref={ref}
{...props}
/>
);
Toggle.displayName = TogglePrimitive.Root.displayName;
export { Toggle, toggleVariants };
Frequently asked questions
- What is Toggle?
- Toggle is a two-state button component for React, built on Radix UI's Toggle primitive. It switches a single option on or off and reflects the pressed state via data-[state=on] styling.
- How do I add Toggle?
- Run pnpm dlx shadcn@latest add https://ui.vllnt.com/r/toggle.json to copy the source into your project, then import Toggle from your ui directory.
- What variants and sizes does Toggle support?
- Toggle ships default and outline variants and three sizes — sm, default, and lg — all configured through the toggleVariants CVA helper and overridable with className.