Toggle
A two-state button for toolbars: pressing fills the background from the centre and gives the icon a small pop. Exposes aria-pressed.
- Category: Inputs
- Licence: Free, MIT
- Built with: React 19, Tailwind CSS 4, Motion
- Dependencies: motion, clsx, tailwind-merge
Examples
Toggle
API reference
| Prop | Type | Default | Description |
|---|---|---|---|
pressed / defaultPressed | boolean | false | |
onPressedChange | (pressed: boolean) => void | — | |
label | string | — | For icon-only toggles. |
size | "sm" | "md" | "lg" | "md" | |
children | ReactNode | — | |
className | string | — |
About Toggle
Toggle is a two-state button for toolbars and filters: pressing it fills the background out from the centre and gives the icon a small pop, so on and off are clear at a glance.
Toggle is an input component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.
When to use Toggle
- Bold, italic and underline in editors.
- Filter chips.
- Mute and pin buttons.
- View options in toolbars.
How it works
It is a button with aria-pressed and an optional label for icon-only use. The fill is a spring on scale and opacity, and three sizes are built in.
It is a real form control: it has an accessible name, works with the keyboard alone, shows a visible focus ring and announces its state to screen readers. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.
Customizing Toggle
Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.
The Customize panel next to the preview lets you change size live, and the Code tab updates to match, so the snippet you copy already carries your values.
- pressed / defaultPressed (boolean, default false).
- label (string): For icon-only toggles.
- size ("sm" | "md" | "lg", default "md").
Goes well with Toggle
These inputs pieces share its tokens and motion language, so they sit together on one page without clashing.
- Range Slider: Six animated React range sliders on one accessible core: inline, tick, fluid, wave, bubble and ruler
- Button: An animated React button with six variants, spring press feedback and a width-stable loading state
- Switch: An animated React toggle switch whose thumb stretches when pressed, like a real switch
- Checkbox: An animated React checkbox: the check draws itself in, the box pops, indeterminate morphs to a dash
- Radio Group: An animated React radio group with roving focus and a highlight that glides between card options
Install Toggle
npx shadcn@latest add https://charcoalui.com/r/toggle.jsonToggle is free and MIT licensed. The command copies toggle.tsx into components/ui and installs clsx, tailwind-merge; you can also copy the source from the Code tab by hand.
Charcoal UI Pro adds 393 more showpiece components, 112 sections and 100 templates built the same way.
Frequently asked questions
- How do I install Toggle?
- Run npx shadcn@latest add https://charcoalui.com/r/toggle.json. The shadcn CLI copies toggle.tsx into components/ui and installs motion, clsx, tailwind-merge. You can also copy the source from this page by hand.
- Is Toggle free for commercial use?
- Yes. Toggle is MIT licensed: use it in any personal or commercial project and change it however you like.
- Does Toggle work with Next.js?
- Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
- Can an AI coding agent install Toggle?
- Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Toggle's props and source and get_install_command returns the exact command.