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.

Examples

Basic

Reverse (toggle on right)

Label and check

Without label

Disabled

Documentation

Overview

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.

CSS variables


	.pf-c-switch	--pf-c-switch--FontSize	1rem
--pf-c-switch--FontSize --pf-global--FontSize--md $pf-global--FontSize--md pf-font-prem(16px) 1rem
	.pf-c-switch	--pf-c-switch__label--PaddingLeft	1rem
--pf-c-switch__label--PaddingLeft --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-switch	--pf-c-switch--ColumnGap	1rem
--pf-c-switch--ColumnGap --pf-c-switch__label--PaddingLeft --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-switch	--pf-c-switch__toggle-icon--FontSize	calc(1rem * .625)
--pf-c-switch__toggle-icon--FontSize calc(--pf-c-switch--FontSize * .625) calc(--pf-global--FontSize--md * .625) calc($pf-global--FontSize--md * .625) calc(pf-font-prem(16px) * .625) calc(1rem * .625)
	.pf-c-switch	--pf-c-switch__toggle-icon--Color	#fff
--pf-c-switch__toggle-icon--Color --pf-global--Color--light-100 $pf-global--Color--light-100 $pf-color-white #fff
	.pf-c-switch	--pf-c-switch__toggle-icon--Left	calc(1rem * .4)
--pf-c-switch__toggle-icon--Left calc(--pf-c-switch--FontSize * .4) calc(--pf-global--FontSize--md * .4) calc($pf-global--FontSize--md * .4) calc(pf-font-prem(16px) * .4) calc(1rem * .4)
	.pf-c-switch	--pf-c-switch__toggle-icon--Offset	0.125rem
	.pf-c-switch	--pf-c-switch--LineHeight	1.5
--pf-c-switch--LineHeight --pf-global--LineHeight--md $pf-global--LineHeight--md 1.5
	.pf-c-switch	--pf-c-switch--Height	auto
	.pf-c-switch	--pf-c-switch__input--checked__toggle--BackgroundColor	#06c
--pf-c-switch__input--checked__toggle--BackgroundColor --pf-global--primary-color--100 $pf-global--primary-color--100 $pf-color-blue-400 #06c
	.pf-c-switch	--pf-c-switch__input--checked__toggle--before--TranslateX	calc(100% + 0.125rem)
--pf-c-switch__input--checked__toggle--before--TranslateX calc(100% + --pf-c-switch__toggle-icon--Offset) calc(100% + 0.125rem)
	.pf-c-switch	--pf-c-switch__input--checked__label--Color	#151515
--pf-c-switch__input--checked__label--Color --pf-global--Color--dark-100 $pf-global--Color--dark-100 $pf-color-black-900 #151515
	.pf-c-switch	--pf-c-switch__input--not-checked__label--Color	#6a6e73
--pf-c-switch__input--not-checked__label--Color --pf-global--disabled-color--100 $pf-global--disabled-color--100 $pf-color-black-600 #6a6e73
	.pf-c-switch	--pf-c-switch__input--disabled__label--Color	#6a6e73
--pf-c-switch__input--disabled__label--Color --pf-global--disabled-color--100 $pf-global--disabled-color--100 $pf-color-black-600 #6a6e73
	.pf-c-switch	--pf-c-switch__input--disabled__toggle--BackgroundColor	#d2d2d2
--pf-c-switch__input--disabled__toggle--BackgroundColor --pf-global--disabled-color--200 $pf-global--disabled-color--200 $pf-color-black-300 #d2d2d2
	.pf-c-switch	--pf-c-switch__input--disabled__toggle--before--BackgroundColor	#f5f5f5
--pf-c-switch__input--disabled__toggle--before--BackgroundColor --pf-global--palette--black-150 $pf-color-black-150 #f5f5f5
	.pf-c-switch	--pf-c-switch__input--focus__toggle--OutlineWidth	2px
--pf-c-switch__input--focus__toggle--OutlineWidth --pf-global--BorderWidth--md $pf-global--BorderWidth--md 2px
	.pf-c-switch	--pf-c-switch__input--focus__toggle--OutlineOffset	0.5rem
--pf-c-switch__input--focus__toggle--OutlineOffset --pf-global--spacer--sm $pf-global--spacer--sm pf-size-prem(8px) 0.5rem
	.pf-c-switch	--pf-c-switch__input--focus__toggle--OutlineColor	#06c
--pf-c-switch__input--focus__toggle--OutlineColor --pf-global--primary-color--100 $pf-global--primary-color--100 $pf-color-blue-400 #06c
	.pf-c-switch	--pf-c-switch__toggle--Height	calc(1rem * 1.5)
--pf-c-switch__toggle--Height calc(--pf-c-switch--FontSize * --pf-c-switch--LineHeight) calc(--pf-global--FontSize--md * --pf-global--LineHeight--md) calc($pf-global--FontSize--md * $pf-global--LineHeight--md) calc(pf-font-prem(16px) * 1.5) calc(1rem * 1.5)
	.pf-c-switch	--pf-c-switch__toggle--BackgroundColor	#8a8d90
--pf-c-switch__toggle--BackgroundColor --pf-global--palette--black-500 $pf-color-black-500 #8a8d90
	.pf-c-switch	--pf-c-switch__toggle--BorderRadius	calc(1rem * 1.5)
--pf-c-switch__toggle--BorderRadius --pf-c-switch__toggle--Height calc(--pf-c-switch--FontSize * --pf-c-switch--LineHeight) calc(--pf-global--FontSize--md * --pf-global--LineHeight--md) calc($pf-global--FontSize--md * $pf-global--LineHeight--md) calc(pf-font-prem(16px) * 1.5) calc(1rem * 1.5)
	.pf-c-switch	--pf-c-switch__toggle--before--Width	calc(1rem - 0.125rem)
--pf-c-switch__toggle--before--Width calc(--pf-c-switch--FontSize - --pf-c-switch__toggle-icon--Offset) calc(--pf-global--FontSize--md - 0.125rem) calc($pf-global--FontSize--md - 0.125rem) calc(pf-font-prem(16px) - 0.125rem) calc(1rem - 0.125rem)
	.pf-c-switch	--pf-c-switch__toggle--before--Height	calc(1rem - 0.125rem)
--pf-c-switch__toggle--before--Height --pf-c-switch__toggle--before--Width calc(--pf-c-switch--FontSize - --pf-c-switch__toggle-icon--Offset) calc(--pf-global--FontSize--md - 0.125rem) calc($pf-global--FontSize--md - 0.125rem) calc(pf-font-prem(16px) - 0.125rem) calc(1rem - 0.125rem)
	.pf-c-switch	--pf-c-switch__toggle--before--Top	calc((calc(1rem * 1.5) - calc(1rem - 0.125rem)) / 2)
--pf-c-switch__toggle--before--Top calc((--pf-c-switch__toggle--Height - --pf-c-switch__toggle--before--Height) / 2) calc((calc(--pf-c-switch--FontSize * --pf-c-switch--LineHeight) - --pf-c-switch__toggle--before--Width) / 2) calc((calc(--pf-global--FontSize--md * --pf-global--LineHeight--md) - calc(--pf-c-switch--FontSize - --pf-c-switch__toggle-icon--Offset)) / 2) calc((calc($pf-global--FontSize--md * $pf-global--LineHeight--md) - calc(--pf-global--FontSize--md - 0.125rem)) / 2) calc((calc($pf-global--FontSize--md * $pf-global--LineHeight--md) - calc($pf-global--FontSize--md - 0.125rem)) / 2) calc((calc(pf-font-prem(16px) * 1.5) - calc(pf-font-prem(16px) - 0.125rem)) / 2) calc((calc(1rem * 1.5) - calc(1rem - 0.125rem)) / 2)
	.pf-c-switch	--pf-c-switch__toggle--before--Left	calc((calc(1rem * 1.5) - calc(1rem - 0.125rem)) / 2)
--pf-c-switch__toggle--before--Left --pf-c-switch__toggle--before--Top calc((--pf-c-switch__toggle--Height - --pf-c-switch__toggle--before--Height) / 2) calc((calc(--pf-c-switch--FontSize * --pf-c-switch--LineHeight) - --pf-c-switch__toggle--before--Width) / 2) calc((calc(--pf-global--FontSize--md * --pf-global--LineHeight--md) - calc(--pf-c-switch--FontSize - --pf-c-switch__toggle-icon--Offset)) / 2) calc((calc($pf-global--FontSize--md * $pf-global--LineHeight--md) - calc(--pf-global--FontSize--md - 0.125rem)) / 2) calc((calc($pf-global--FontSize--md * $pf-global--LineHeight--md) - calc($pf-global--FontSize--md - 0.125rem)) / 2) calc((calc(pf-font-prem(16px) * 1.5) - calc(pf-font-prem(16px) - 0.125rem)) / 2) calc((calc(1rem * 1.5) - calc(1rem - 0.125rem)) / 2)
	.pf-c-switch	--pf-c-switch__toggle--before--BackgroundColor	#fff
--pf-c-switch__toggle--before--BackgroundColor --pf-global--BackgroundColor--100 $pf-global--BackgroundColor--100 $pf-color-white #fff
	.pf-c-switch	--pf-c-switch__toggle--before--BorderRadius	30em
--pf-c-switch__toggle--before--BorderRadius --pf-global--BorderRadius--lg $pf-global--BorderRadius--lg 30em
	.pf-c-switch	--pf-c-switch__toggle--before--BoxShadow	0 0.25rem 0.5rem 0rem rgba(3, 3, 3, 0.12), 0 0 0.25rem 0 rgba(3, 3, 3, 0.06)
--pf-c-switch__toggle--before--BoxShadow --pf-global--BoxShadow--md $pf-global--BoxShadow--md 0 pf-size-prem(4px) pf-size-prem(8px) pf-size-prem(0) rgba($pf-color-black-1000, .12), 0 0 pf-size-prem(4px) 0 rgba($pf-color-black-1000, .06) 0 pf-size-prem(4px) pf-size-prem(8px) pf-size-prem(0) rgba(#030303, .12), 0 0 pf-size-prem(4px) 0 rgba(#030303, .06) 0 0.25rem 0.5rem 0rem rgba(3, 3, 3, 0.12), 0 0 0.25rem 0 rgba(3, 3, 3, 0.06)
	.pf-c-switch	--pf-c-switch__toggle--before--Transition	transform .25s ease 0s
	.pf-c-switch	--pf-c-switch__toggle--Width	calc(calc(1rem * 1.5) + 0.125rem + calc(1rem - 0.125rem))
--pf-c-switch__toggle--Width calc(--pf-c-switch__toggle--Height + --pf-c-switch__toggle-icon--Offset + --pf-c-switch__toggle--before--Width) calc(calc(--pf-c-switch--FontSize * --pf-c-switch--LineHeight) + 0.125rem + calc(--pf-c-switch--FontSize - --pf-c-switch__toggle-icon--Offset)) calc(calc(--pf-global--FontSize--md * --pf-global--LineHeight--md) + 0.125rem + calc(--pf-global--FontSize--md - 0.125rem)) calc(calc($pf-global--FontSize--md * $pf-global--LineHeight--md) + 0.125rem + calc($pf-global--FontSize--md - 0.125rem)) calc(calc(pf-font-prem(16px) * 1.5) + 0.125rem + calc(pf-font-prem(16px) - 0.125rem)) calc(calc(1rem * 1.5) + 0.125rem + calc(1rem - 0.125rem))
	.pf-c-switch	--pf-c-switch__label--Color	#151515
--pf-c-switch__label--Color --pf-global--Color--dark-100 $pf-global--Color--dark-100 $pf-color-black-900 #151515

View source on GitHub

QUICKLINKS

CONTRIBUTE

STAY IN TOUCH

Privacy statement Terms of use All policies and guidelines