Toggle

StableBase UI

Live preview

Installation

pnpm dlx shadcn@latest add @sc1m/toggle

This also merges the token layer and installs src/lib/cn.ts plus @base-ui/react. For the manual route — prerequisites, components.json, and app-level setup — see Installation.

Usage

import { Toggle } from "@/components/ui/toggle";

Example

The preview above, with its source. This is the demo module verbatim, so the code and the thing it renders cannot drift apart.

<Toggle aria-label="Bold">B</Toggle>

API reference

Each part forwards every prop of its Base UI counterpart; the tables list the ones declared on the part itself. See Base UI's reference for the inherited element props.

PropTypeDefaultDescription

pressedboolean—Whether the toggle button is currently pressed.

defaultPressedbooleanfalseWhether the toggle button is currently pressed.

disabledbooleanfalseWhether the component should ignore user interaction.

onPressedChange((pressed: boolean, eventDetails: Toggle.ChangeEventDetails) => void)—Callback fired when the pressed state is changed.

valueValue—A unique string that identifies the toggle when used inside a toggle group.

Accessibility

Behaviour, focus management, and ARIA wiring come from Base UI's Toggle — see its reference for the full keyboard map.

Keyboard focus draws a 2px ring in --ring, never removed — only shown on :focus-visible, so a pointer press does not paint one.
Disabled parts mute their contents rather than the element, keeping the focus ring at full strength where the part stays focusable.

Design tokens

The component reads semantic tokens only — no raw colour, radius, or duration appears in its source. Override the token, not the component.

TokenApplied to

--accentToggle

--accent-fgToggle

--brand-radius-mdToggle

--fgToggle

--ringToggle

--surfaceToggle

Source

src/components/ui/toggle/toggle.tsx — no next/* imports, so it drops into any React 19 + Tailwind v4 app.

Toggle

On this page