`<pf-v5-switch>`

A **switch** toggles the state of a setting (between on and off).

Category: Forms
Built with: Lit
Library: PatternFly Elements
Author: Red Hat
Package: @patternfly/elements
Component size: 3.9 kB JS (minified + gzipped, JS includes dependencies beyond the library)
Library size: 6.3 kB JS (shared by every PatternFly Elements component, loaded once per page)
Popular: 2 out of 5
Downloads: 3,967/week (whole @patternfly/elements package)
Latest stable version: 5.0.0
Last published: May 3, 2026
License: MIT

Documentation
Source code

Source code

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.

Attributes

label
accessible-label
show-check-icon
checked
disabled

Events

change