Skip to main content
v0.1 dev

Selection

Switch

Toggles an immediately applied setting between on and off.

implementedReference catalog.he-switchHeSwitch

Overview

Toggles an immediately applied setting between on and off. Its semantic foundation is Checkbox or switch with accessible name and state. Source scope: Reference catalog.

This element maps to the existing switch component contract.

Visual Example

When to Use

Use Switch when its semantic purpose matches the user task. Prefer native platform behavior, concise labels, predictable placement, and content that remains understandable without visual styling.

Do

  • Use the canonical element ID and semantic role.
  • Keep labels and state programmatically available.
  • Test the element with real content and every supported input modality.

Don't

  • Do not substitute a visually similar element with different semantics.
  • Do not add focusable descendants without a documented keyboard model.
  • Do not communicate state through color or motion alone.

Anatomy

1Persistent label
2Control
3Current value
4Help or error text

Variants

defaultcompactdisabled

Variants preserve the same semantics and accessible name. Density changes never reduce the minimum interactive target.

States

resthoverfocus-visibleselectedinvaliddisabled

Focus-visible takes precedence over hover and selected styling. Loading and disabled behavior never silently remove essential information or recovery paths.

Behavior

Use native form behavior or the documented composite widget pattern without changing expected keys. Web targets are at least 44 × 44 CSS pixels and Flutter targets are at least 48 × 48 dp.

Accessibility

Checkbox or switch with accessible name and state. The element exposes an accessible name, role, state, value, and result where applicable; retains visible 3:1 focus indication; supports 200% text scaling and 320 CSS pixel reflow; and preserves structure in forced-colors and reduced-motion modes.

Tokens

color.* semantic rolescomponent.switch.*.he-switch

Spacing, sizing, typography, border, radius, icon, motion, focus, and color decisions resolve from canonical tokens. Element code does not contain arbitrary visual literals.

Web and Flutter API

Web

<div class="he-switch">Switch</div>

Flutter

HeSwitch(
  child: const Text('Switch'),
)

ds-switch is a registry identifier only; this library does not register an autonomous custom element under that name. Use the mapped component or native semantic composition shown above.

When an element includes an icon, use the exact Tabler name and semantic size from Foundations · Iconography.

Status

implemented. The contract is registered, visually represented, and included in automated documentation and accessibility validation. This status describes contract coverage, not independent production certification.