Toggle Button

A single on/off action with native button keyboard behavior and an accessible pressed state. Use it for toolbar controls such as pin, favourite or preview mode.

Core UI · React · Subscription · commercial licence · v1.0.3 · updated 2026-10-18 · Live demo

Install

velocityx add toggle-button

Subscription component. Run velocityx login with your key first — get one.

---
import ToggleButton from '../components/velocity/toggle-button/ToggleButton.jsx';
---
<ToggleButton client:visible />

Props

Prop	Type	Default	Description
pressed	—	undefined	—
defaultPressed	boolean	false	—
onPressedChange	—	undefined	—
disabled	boolean	false	—
children	—	undefined	—
label	—	undefined	—
className	string	''	—

Files written

velocityx drops these into your project:

• components/velocity/toggle-button/ToggleButton.jsx

Peer dependencies

react — nothing else. Zero external dependencies is the point.

Theming

Colours come from the primary-* / accent-* Tailwind scales, so this drops into a project that is not Velocity without dragging our brand in. Install the contract once:

velocityx theme

Then set your whole brand in one place — raw RGB channels, not hex (a hex here silently breaks every opacity variant):

:root {
  --vx-brand: custom;
  --vx-primary-600: 220 38 38;
}

There is no component-level font-family anywhere in the library — your font cascade wins.

Licence

Commercial, for the duration of an active Velocity X subscription. The source is served by the licence-gated endpoint, never by the public CDN.