Core UI
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.
$ velocityx add toggle-button
Needs a licence key — buy lifetime access here, then
velocityx login once.
$ velocityx add toggle-button@1.0.2
Needs a licence key — buy lifetime access here, then
velocityx login once.
$ velocityx add toggle-button@1.0.1
Needs a licence key — buy lifetime access here, then
velocityx login once.
$ velocityx add toggle-button@1.0.0
Needs a licence key — buy lifetime access here, then
velocityx login once.
Built for react.
Needs react already installed
as a peer dependency.
An Astro-only project needs @astrojs/react wired up first — this won't run on its own in plain Astro.
- Framework
- react
- Source
- 73 lines
- ToggleButton.jsx
- Runtime
- Interactive
- runs in the browser
- Theme
- 8 tokens
- re-themes from your scale
- Dark mode
- Built in
- dark: variants
- Accessibility
- 2 ARIA
- attributes and roles
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| pressed | boolean | No | undefined | Controlled pressed state. |
| defaultPressed | boolean | No | false | Initial local state. |
| onPressedChange | undefined | No | undefined | function(nextPressed: boolean) Called after an activation. |
| disabled | boolean | No | false | Disables activation. |
| children | ReactNode | No | undefined | Visible button content. |
| label | string | No | undefined | Accessible name override; required for icon-only content. |
| className | string | No | '' | Additional button classes. |
Using it
The smallest call that compiles — required props only. The import is
written for your own file at src/components/Example.jsx;
adjust the relative import if yours sits elsewhere.
Everything optional is in the table above, with its default.
import ToggleButton from './velocity/toggle-button/ToggleButton';
export default function Example() {
return <ToggleButton label="Pin this project">Pin project</ToggleButton>;
}Built from Toggle Button's own prop signature and the path the CLI installs it to, so it can't drift from either.
Accessibility
- ARIA attributes
- aria-label, aria-pressed
- Keyboard
- Built on native controls — Enter/Space work as standard
Read from the source, not asserted — anything not listed simply isn't in this component's markup.
Behaviour
- Ships client JS
- Yes — this one needs to hydrate
- React hooks
- useState
- Dark mode
- Carries its own dark: variants
Theming
This component paints from 8 steps of
your theme scale — no hardcoded colours, and no font-family of
its own, so your type cascade wins. Override the variables and it follows.
primary-50primary-100primary-300primary-500primary-600primary-700primary-900primary-950Get the Velocity preset and CSS theme from the public source guide. The CLI theme command is not available on npm yet.
File this creates
The CLI writes this path into your project — nothing
else moves. Paths are under your source root, which defaults to
src/; pass
--dest if yours is elsewhere.
-
src/components/velocity/toggle-button/ToggleButton.jsx73 lines
Copy the paths
src/components/velocity/toggle-button/ToggleButton.jsxVersions
4 published versions are preserved with their own access level and source hash. The CLI can pin to any version and upgrade without overwriting local edits.
- v1.0.3 Current Subscription18 Oct 2026
velocityx add toggle-button - v1.0.2Subscription18 Oct 2026
velocityx add toggle-button@1.0.2 - v1.0.1Subscription18 Oct 2026
velocityx add toggle-button@1.0.1 - v1.0.0Subscription18 Oct 2026
velocityx add toggle-button@1.0.0
Toggle Button — questions
How do I install Toggle Button?
Run velocityx add toggle-button . The CLI writes the source straight into your project — it is not a runtime package dependency.
Do I need a licence for Toggle Button?
Yes. It is part of the lifetime library — buy access at https://aidxn.com/shop/velocity-x-component-library/, authenticate once, and install it. Your lifetime licence includes future component updates.
Can I edit Toggle Button after installing it?
Yes — the files are yours once written. The CLI compares its lockfile hash before upgrades and refuses to overwrite code you changed.
Does Toggle Button ship JavaScript to my users?
Yes. It runs in the browser (useState), so it needs to hydrate — in Astro, give it a client:* directive.
Will Toggle Button match my brand colours?
Yes. It paints entirely from your theme scale — 8 steps of primary-* / accent-* — with no hardcoded hex values and no font-family of its own. Override the theme CSS variables and it follows your design system instead of ours.
Which version of Toggle Button should I install?
There are 4 published versions, and the default install gives you the current one. Pin an older one with velocityx add toggle-button@<version> , or move between them later with velocityx upgrade toggle-button — downgrades work too.
Does Toggle Button pull in any dependencies?
No external ones. Every component in the library is built with react/react-dom or plain Astro only — no GSAP, Radix, Swiper or Headless UI — which is what makes dropping it into an existing project safe.
Set up & reference
All docs →Install this component:
$ velocityx add toggle-button- 2. Install the theme — run this first, once per project Do this once per project, before your first component.
- The palette gotcha — this one bites silently Silent failure — the component renders, just unstyled.
- Your edits are safe by default What happens to your changes when you upgrade.
- You own the code What you are actually buying.
Related components
More from Core UI.
Expand/collapse FAQ list with measured-height animation, single or multi-open modes, and arrow-key navigation between headers.
reactAuroraMegaMenuHeader — one-bar header with a cursor-follow spotlight, an animated gradient hairline, and glass mega-menu panels with a rotating gradient border.
reactFloating button that fades in past a scroll threshold and scrolls to top, instantly under reduced motion.
reactA labelled multi-choice group built on native checkboxes, with optional descriptions, per-option disabled state, and controlled or local array values.
react