We use cookies on our websites to deliver our online services. Details about how we use cookies and how you may disable them are set out in our Privacy Statement. By using this website you agree to our use of cookies.
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.
A switch is an alternative to the checkbox component.
Use a switch when your user needs to perform instantaneous actions without confirmation.
Use checkbox if your user has to perform additional steps for changes to become effective.
Accessibility
Attribute
Applied to
Outcome
aria-labelledby="..." or aria-label="..."
.pf-c-switch__input
Indicates the action triggered by the switch. If an additional text label is included with the switch besides .pf-c-switch__label.pf-m-on, then aria-labelledby can reference the id of this text, or this text can be used as the value for aria-label. If the text included for .pf-c-switch__label.pf-m-on provides additional meaning to the primary label that's referenced, then it can also be represented as part of the aria-labelledby or aria-label attribute. Required
for
<label>
Each <label> must have a for attribute that matches its input id. Required
id
<input type="checkbox">
Each <input> must have an id attribute that matches its label's for value. Required
id
.pf-c-switch__label
Each .pf-c-switch__label must have an id attribute that matches the aria-labelledby on .pf-c-switch__input.
checked
.pf-c-switch__input
Indicates that the input is checked
disabled
.pf-c-switch__input
Indicates that the input is disabled
aria-hidden="true"
.pf-c-switch__label
Hides the text from the screen reader.
Usage
Class
Applied to
Outcome
.pf-c-switch
<label>
Initiates a switch. Required
.pf-c-switch__input
<input type="checkbox">
Hide the checkbox inside the switch. Required
.pf-c-switch__toggle
<span>
Initiates the toggle inside the switch. Required
.pf-c-switch__toggle-icon
<span>
Initiates the switch toggle icon wrapper. Required when the switch is used without a label
.pf-c-switch__label
<span>
Initiates a label inside the switch.
.pf-m-on
.pf-c-switch__label
Modifies the switch label to display the on message.
.pf-m-off
.pf-c-switch__label
Modifies the switch label to display the off message.
.pf-m-reverse
.pf-c-switch
Positions the switch toggle to the right of the label.
