Overview
Getting Started
Installation
About
Changelog
Core Concepts
Layout
Responsive
Theming
Layout Components
Box
Alpha
Container
Alpha
Grid
Alpha
Flex
Alpha
Components
Avatar
Alpha
Button
Alpha
ButtonIcon
Alpha
ButtonLink
Alpha
Card
Alpha
Checkbox
Alpha
Collapsible
Alpha
Dialog
Alpha
Header
Alpha
HeaderPage
Alpha
Link
Alpha
Menu
Alpha
PasswordField
Alpha
RadioGroup
Alpha
SearchField
Alpha
Select
Alpha
Skeleton
Alpha
Switch
Alpha
Table
Alpha
Tabs
Alpha
TagGroup
Alpha
Text
Alpha
TextField
Alpha
Tooltip
Alpha
VisuallyHidden
Alpha
Version 0.8.2 - Alpha
Switch
component

Switch

A control that indicates whether a setting is on or off.

Usage

import { Switch } from '@backstage/ui';

<Switch />

API reference

PropTypeDefaultResponsive
autoFocus
boolean
-No
defaultSelected
boolean
-No
className
string
-No
isDisabled
boolean
-No
isReadOnly
boolean
-No
isSelected
boolean
-No
label
string
-No
name
string
-No
onChange
(isSelected: boolean) => void
-No
onFocus
(e: FocusEvent<Target>) => void
-No
onBlur
(e: FocusEvent<Target>) => void
-No
onFocusChange
(isFocused: boolean) => void
-No
onKeyDown
(e: KeyboardEvent) => void
-No
onKeyUp
(e: KeyboardEvent) => void
-No
onHoverStart
(e: HoverEvent) => void
-No
onHoverEnd
(e: HoverEvent) => void
-No
onHoverChange
(isHovered: boolean) => void
-No
style
CSSProperties
-No
value
string
-No

Examples

Disabled

A switch can be disabled using the isDisabled prop.

<Switch isDisabled />

Theming

Our theming system is based on a mix between CSS classes, CSS variables and data attributes. If you want to customise this component, you can use one of these class names below.

Changelog