Switch component

Figma Component

Switch toggles the state of a single setting on or off. The setting it controls and the setting state should be made clear from the components inline label.

Properties

NameDescriptionDefault
busy

Input busy state

-
description
Checkbox description
-
Note: This table does not include native DOM and React properties like `onClick`, `ref`, `id`, `aria-label` (and many others) supported by this component.

Busy

When a switch component is a part of a form that is currently busy (e.g. data is asynchronous validated or saved) the input field should be marked with the `busy` attribute. The component will be set as disabled, but will be visually different from `disabled` state.

Disabled

A component that is unavailable for input changes, should be marked with the `disabled` property.