Toggle

A pressed-state button using native button behavior. CSS only

Choosing between components

Use Toggle for a button that stays pressed, such as bold in a toolbar. Use Switch for a setting that applies immediately, which is a checkbox rather than a button.

Toggle

Copy this markup

<button class="ui-button ui-toggle" type="button" aria-pressed="true">Bold</button>

Install

Styles and registration

import '@timelessui/components/css/tokens.css'
import '@timelessui/components/css/core/toggle.css'
import '@timelessui/components/css/core/button.css'
import '@timelessui/components/css/themes/atmosphere/tokens.css'
import '@timelessui/components/css/themes/atmosphere/button.css'
import '@timelessui/components/css/themes/atmosphere/toggle.css'

Attributes

Every value below is implemented by the stylesheets this component ships. Boolean attributes are presence-based: author the attribute with no value, or omit it.

Attribute	Values	Default	Description
data-ui-variant	primary · secondary · outline · ghost · danger · danger-outline · link	primary	Visual intent, resolved by themes/atmosphere/button.css. Author class="ui-button ui-toggle" so the shared button styling applies.
data-ui-size	sm · md · lg	md	Control height, padding, and font size. Resolved by themes/atmosphere/button.css.

State

Native attributes, ARIA, and platform pseudo-classes are authoritative. Style state through the selectors below rather than adding your own state classes.

State	Source	How to express it
pressed	aria	Author aria-pressed="true" or "false"; never omit it.
disabled	native	Native disabled.

Styling

Root identity: ui-toggle. Required stylesheets: tokens.css, core/toggle.css, core/button.css, themes/atmosphere/tokens.css, themes/atmosphere/button.css, themes/atmosphere/toggle.css.

This component adds no custom properties of its own. Restyle it through the design tokens or your own CSS.

Design tokens this component reads (24)

These are global Atmosphere tokens. Change them once at the theme level rather than per component.

--ui-accent · --ui-accent-soft · --ui-bg-accent · --ui-bg-accent-active · --ui-bg-accent-hover · --ui-bg-control · --ui-bg-control-active · --ui-bg-control-hover · --ui-bg-control-muted · --ui-bg-danger · --ui-bg-danger-active · --ui-bg-danger-hover · --ui-duration-fast · --ui-ease-standard · --ui-fg · --ui-focus · --ui-line · --ui-radius-control · --ui-shadow-control-accent · --ui-shadow-control-active · --ui-shadow-control-danger · --ui-shadow-control-hover · --ui-shadow-outline-control · --ui-space-2

Accessibility

Keep the native elements, roles, and relationships shown in the example. Timeless adds only the state and keyboard coordination the platform does not already provide, and it never supplies your accessible names — those depend on your content.

This component declares no keyboard contract, because it has none of its own: the markup above is native elements and native ARIA, and everything a keyboard or a screen reader does with it comes from the platform. Nothing here manages focus, and nothing here adds a role you did not author. So the accessibility of this component is the accessibility of the markup — which is why the markup is the part worth copying exactly.

Before JavaScript runs

This primitive is CSS only. There is nothing to register and nothing to wait for.

More examples

Open Toggle in StoryLite for variants, controls, and manual testing.