Skip to main content Home About the Design SystemRoadmap OverviewDesignersDevelopers OverviewColorGridIconographyInteractionsSpacingTypography Overview Global colorBox shadowTypographyBorderOpacitySpaceLengthIconBreakpointsMedia queries All elements Accordion Alert Announcement Audio player Avatar Back to top Badge Blockquote Breadcrumb Button Card Chip Code block Call to action Dialog Disclosure Footer Health index Icon Jump links Menu dropdown Navigation link Navigation (primary) Navigation (secondary) Navigation (vertical) Pagination PopoverPlanned Progress stepper Scheme toggle Site status Skeleton Skip link Spinner Statistic Subnavigation Surface Switch Table Tabs Tag Tile Timestamp Tooltip Video embed OverviewColor PalettesCustomizingDevelopers All PatternsAccordionCall to ActionCardFilterFormLink with iconLogo wallSearch barSticky bannerSticky cardTabsTagTile All Personalization PatternsAnnouncement FundamentalsAccessibility toolsAssistive technologiesCI/CDContentContributorsDesignDevelopmentManual testingResourcesScreen readers Design/code status Release notes Get support

Switch

OverviewStyleGuidelinesCodeAccessibilityDemos
OverviewStatusWhen to useStatus checklistOverviewStatusWhen to useStatus checklist

Overview

A switch provides a visible toggle for a setting. Authors must supply an accessible label via accessible-label or a <label for>. The element uses ARIA role="switch" with aria-checked for screen readers. Users should toggle with Space or Enter keys. Avoid using a switch when multiple selections are needed; use checkboxes instead.

import '@rhds/elements/rh-switch/rh-switch.js';
 
rh-switch {
  margin: var(--rh-space-lg);
}
 
<rh-switch id="switch-a" accessible-label="Switch A" message-on="Message when on" message-off="Message when off" checked=""></rh-switch>
 
import { Switch } from "@rhds/elements/react/rh-switch/rh-switch.js";

// NOTE: React 19+ does not require these wrapper imports.
// You can use the custom elements directly as-is.

export const Demo = () => (
  <Switch id="switch-a" accessible-label="Switch A" message-on="Message when on" message-off="Message when off" checked />
);

invisible, accessible label for screen readers

Message to display when the switch is on (i.e. checked)

Message to display when the switch is off (i.e. unchecked)

If the checkmark icon should be displayed when the switch is on

Whether the switch is on (checked)

If the switch is disabled

If the switch is reversed: message first, then control

 View source on GitHub

Status

When to use

  • When users need to choose between two binary actions
  • When users need to immediately activate or deactivate something
  • When users need to toggle an item on or off

Status checklist

Edit this page on GitHub
© 2026 Red Hat Deploys by Netlify