Semantics
A labelled switch with optional description and native form state.
Forms and selection · stable · MIT
Switch
A binary Base UI control with one connected track and gel thumb.
Install editable source
Add Switch
Behavior contract
Semantics before surface
Keyboard
Space toggles.
System support
Light and dark themes, logical RTL layout, reduced motion, responsive content, and forwarded public refs.
Source-derived reference
Anatomy and public API
Exported anatomy
These public React parts are read directly from the canonical source during the documentation build.
GummySwitch
Prop contracts
GummySwitchProps
Composes Omit< Switch.Root.Props, "children" | "nativeButton" | "render" > & { /** Visible control label. */ label: React.ReactNode; /** Optional supporting copy associated with the switch. */ description?: React.ReactNode; /** Keeps forced states in the Lab visually inspectable without changing semantics. */ previewFocus?: boolean; className?: string; }
Troubleshooting
Check behavior before surface.
- If the material is missing, confirm the registry-installed shared and component CSS files are imported once.
- If interaction differs, preserve this contract: Space toggles.
- If assistive output differs, preserve this semantic foundation: A labelled switch with optional description and native form state.
- If dark, RTL, or reduced-motion behavior is missing, verify the nearest theme, direction, and media-query boundaries rather than adding page-local overrides.
Live product source
Inspect the canonical states
The Component Lab exercises real source across default, focus, disabled, responsive, dark, reduced-motion, and RTL contexts.
Open the live Component LabInteractive inspection
Try Switch in context
Resize the canvas, switch its theme, or reverse its reading direction without changing the rest of the page.
Switch preview: fluid width, light theme, left to right.
Radix UI counterpart
Try Switch with Radix UI
This is the real separately installable Radix source using the same Gummy material and behavior contract.
Install compatible releases.
Editable source
Read before you install
Canonical Base UI or native source
Loading editable source…
Radix UI counterpart
Loading editable source…