Switch

OverviewStyleGuidelinesCodeAccessibilityDemos
  1. Installation
  2. Usage
  1. Installation
  2. Usage

Installation

We recommend import maps when building pages with RHDS. Learn more about how to install on our getting started docs.

Red Hat CDN 
<script type="importmap">
{
  "imports": {
    "@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@2.1.2/elements/",
  }
}
</script>
Copy to Clipboard Wrap lines NPM 
npm install @rhds/elements
Copy to Clipboard Wrap lines JSPM 
<script type="importmap">
Could not generate import map using JSPM: Cannot read properties of undefined (reading '@rhds/elements')
</script>
Copy to Clipboard Wrap lines

Add it to your page with this import statement

<script type="module">
  import '@rhds/elements/rh-switch/rh-switch.js';
</script>
Copy to Clipboard Wrap lines

Usage

<rh-switch id="switch-a"
           accessible-label="Switch A"
           message-on="Message when on"
           message-off="Message when off"
           checked></rh-switch>

<script type="module">
  import '@rhds/elements/rh-switch/rh-switch.js';
</script>

<style>
  rh-switch {
    margin: var(--rh-space-lg);
  }
</style>
Copy to Clipboard Wrap lines

rh-switch

A switch toggles the state of a setting (between on and off). Switches and checkboxes can often be used interchangeably, but the switch provides a more explicit, visible representation on a setting.

Slots 2
Slot Name Description
message-on

message content when checked. Overrides the message-on attribute.
message-off

message content when unchecked. Overrides the message-off attribute.
Attributes 7
Attribute DOM Property Description Type Default
accessible-label accessibleLabel

invisible, accessible label for screen readers

 
string | undefined
 
unknown
message-on messageOn

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

 
string | undefined
 
unknown
message-off messageOff

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

 
string | undefined
 
unknown
show-check-icon showCheckIcon

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

 
boolean
 
false
checked checked

If the switch is on

 
boolean
 
false
disabled disabled

If the switch is disabled

 
boolean
 
false
reversed reversed

If the switch is reversed: message first, then control

 
boolean
 
false
Methods 1
Method Name Description
formDisabledCallback(disabled: boolean)
Events 1
Event Name Description
change
CSS Shadow Parts 0
None
CSS Custom Properties 3
CSS Property Description Default
--rh-switch-unchecked

The background color of the switch when it is unchecked.

 —
--rh-switch-checked

The background color of the switch when it is checked.

 —
--rh-switch-disabled

The background color of the switch when it is disabled.

 —
Design Tokens 15
Token Copy
--rh-border-radius-pill
--rh-border-width-md
--rh-box-shadow-sm
--rh-color-accent-base
--rh-color-border-interactive
--rh-color-gray-30
--rh-color-gray-40
--rh-color-gray-50
--rh-color-gray-60
--rh-color-surface-dark-alt
--rh-color-surface-lightest
--rh-color-text-primary
--rh-color-text-secondary
--rh-space-lg
--rh-space-sm
Edit this page on GitHub