Switch

InputsPrimitiveBuilt

Binary toggle styled as a slider.

Also known as:

Slide toggle
Toggle switch
ToggleSwitch
Toggle Button
Binary Switch
On/Off Switch
State Toggle

Overview

Purpose

The Switch component binary toggle styled as a slider.within our design system. It follows our primitive layer principles, ensuring consistency and reusability across applications.

When to Use

Use when you need collecting user input
Appropriate for inputs contexts
Follows primitive component patterns

When Not to Use

Avoid when simpler alternatives exist
Don't use for display-only content
Consider alternatives for edge cases

Live Example

import React from 'react';
import Switch from './components/Switch';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Switch
        checked={props.checked || false}
        size={props.size || 'medium'}
        disabled={props.disabled || false}
      >
        {props.children || 'Toggle Switch'}
      </Switch>
    </div>
  );
}

Open Sandbox

Initializing sandbox...

Anatomy

Understanding the structure of the Switch component helps ensure proper implementation and customization.

Component anatomy diagram will be generated based on the actual component structure.

Variants & States

DisabledCheckedSize

Open Sandbox

Initializing sandbox...

API Reference

Props

Props documentation will be auto-generated from the component implementation.

Methods

Method documentation will be extracted from the component interface.

Accessibility

Standards Compliance

This component follows WCAG 2.1 AA guidelines and includes proper ARIA attributes, keyboard navigation, and screen reader support.

Common Pitfalls

Misused as yes/no
unclear semantics.

Accessibility Checklist

✓ Keyboard navigation support
✓ Screen reader compatibility
✓ Color contrast compliance
✓ Focus management
✓ ARIA attributes
✓ Reduced motion support

Usage Guidelines

✓ Do

Use consistent spacing and sizing
Follow established patterns
Provide clear labels and descriptions
Test with assistive technologies

✗ Don't

Override core functionality
Use without proper context
Ignore accessibility requirements
Modify without design system approval

Examples

Basic Usage

import React from 'react';
import Switch from './components/Switch';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Switch
        checked={props.checked || false}
        size={props.size || 'medium'}
        disabled={props.disabled || false}
      >
        {props.children || 'Toggle Switch'}
      </Switch>
    </div>
  );
}

Open Sandbox

Initializing sandbox...

Advanced Usage

import React from 'react';
import Switch from './components/Switch';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Switch
        checked={props.checked || false}
        size={props.size || 'medium'}
        disabled={props.disabled || false}
      >
        {props.children || 'Toggle Switch'}
      </Switch>
    </div>
  );
}