Switch

Switches allow users to turn an individual option on or off. They are usually used to activate or deactivate a specific setting.

installyarn add @react-spectrum/switch
version3.0.0-rc.2
usageimport {Switch} from '@react-spectrum/switch'
View guidelines
Spectrum
View repository
GitHub
View package
NPM

Example#

<Switch>Switch it up</Switch>

Content#

Switches accept children, which are rendered as the label.

Switches are best used for communicating activation (e.g., on/off states), while checkboxes are best used for communicating selection (e.g. multiple table rows). Switches, unlike checkboxes, can't have an error state.

Accessibility#

In certain cases a visible label isn't needed. For example, a Switch located at the top of a panel which toggles the panels options on or off. If a visible label isn't specified, an aria-label must be provided to the Switch for accessibility. If the field is labeled by a separate element, an aria-labelledby prop must be provided using the id of the labeling element instead.

<Switch aria-label="Activate Setting" />

Internationalization#

To internationalize a Switch, a localized label should be passed to the children or aria-label prop. For languages that are read right to left (e.g. Hebrew and Arabic), the layout of the switch is flipped.

Value#

Switches are not selected by default. The defaultSelected prop can be used to set the default state (uncontrolled). Alternatively, the isSelected prop can be used to make the selected state controlled.

<Switch defaultSelected>Uncontrolled</Switch>
<Switch isSelected>Controlled</Switch>

Events#

Switches accept a user defined onChange prop, triggered whenever the Switch is pressed. The example below uses onChange to alert the user to changes in state.

function Example() {
  let [selected, setSelection] = React.useState('false');

  let toggle = (value) => {
    value ? setSelection('true') : setSelection('false');
  }

  return (
    <div>
      <div> The Switch is on: {selected} </div>
      <Switch onChange={toggle}>
        Switch Label
      </Switch>
    </div>
  );
 }

Props#

NameTypeDefaultDescription
isEmphasizedboolean"false"This prop sets the emphasized style which provides visual prominence.
childrenReactNode—The content to render as the Checkbox's label.
defaultSelectedboolean—Whether the Checkbox should be selected (uncontrolled).
isSelectedboolean—Whether the Checkbox should be selected (controlled).
valuestring—The value of the Checkbox input element.
namestring—The name of the Checkbox input element.
isDisabledboolean—Whether the input is disabled.
isRequiredboolean—Whether user input is required on the input before form submission. Often paired with the necessityIndicator prop to add a visual indicator to the input.
validationStateValidationState—Whether the input should display its "valid" or "invalid" visual styling.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
autoFocusboolean—Whether the element should receive focus on render
UNSAFE_classNamestring—The className to apply to the element. Do not use unless completely necessary as it may break component styling.
UNSAFE_styleCSSProperties—The inline styles to apply to the element. Do not use unless completely necessary as it may break component styling.
Events
NameTypeDefaultDescription
onChange(isSelected: boolean) => void—Handler that is called when the Checkbox's selection state changes.
onFocus(e: FocusEvent) => void—Handler that is called when the element receives focus.
onBlur(e: FocusEvent) => void—Handler that is called when the element loses focus.
onFocusChange(isFocused: boolean) => void—Handler that is called when the element's focus status changes.
onKeyDown(e: KeyboardEvent) => void—Handler that is called when a key is pressed.
onKeyUp(e: KeyboardEvent) => void—Handler that is called when a key is released.
Layout
NameTypeDefaultDescription
flexstring | number | boolean—
flexGrownumber—
flexShrinknumber—
flexBasisnumber | string—
alignSelf'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'stretch'—
justifySelf'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'left' | 'right' | 'stretch'—
flexOrdernumber—
gridAreastring—
gridColumnstring—
gridRowstring—
gridColumnStartstring—
gridColumnEndstring—
gridRowStartstring—
gridRowEndstring—
Spacing
NameTypeDefaultDescription
marginDimensionValue—
marginTopDimensionValue—
marginLeftDimensionValue—
marginRightDimensionValue—
marginBottomDimensionValue—
marginStartDimensionValue—
marginEndDimensionValue—
marginXDimensionValue—
marginYDimensionValue—
Sizing
NameTypeDefaultDescription
widthDimensionValue—
minWidthDimensionValue—
maxWidthDimensionValue—
heightDimensionValue—
minHeightDimensionValue—
maxHeightDimensionValue—
Positioning
NameTypeDefaultDescription
position'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'—
topDimensionValue—
bottomDimensionValue—
leftDimensionValue—
rightDimensionValue—
startDimensionValue—
endDimensionValue—
zIndexnumber—
isHiddenboolean—
Accessibility
NameTypeDefaultDescription
idstring—The element's unique identifier.
tabIndexnumber—Indicates whether an element is focusable, allows or prevents them from being sequentially focusable, and determines their relative ordering for sequential focus navigation.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the object.
aria-errormessagestring—Identifies the element that provides an error message for the object.

Visual options#

Disabled#

View guidelines

<Switch isDisabled>Switch Label</Switch>

Emphasized#

View guidelines

<Switch isEmphasized>Switch Label</Switch>

Read only#

<Switch isReadOnly isSelected>Switch Label</Switch>