ToggleSwitch Component

Overview

Purpose

The ToggleSwitch component binary switch control rendered as input[role=switch] with an adjacent label.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 ToggleSwitch from './components/ToggleSwitch';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <ToggleSwitch {...props}>
        {props.children || 'Example toggleswitch content'}
      </ToggleSwitch>
    </div>
  );
}

Open Sandbox

Anatomy

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

Property	Description	Type
root	Slot rendered into [data-slot="toggle-switch"].	Root
toggleSwitch	Toggle switch region of the component.	Part
input	Slot rendered into [data-slot="toggle-switch-input"].	Slot (required)
label	Slot rendered into [data-slot="toggle-switch-label"].	Slot
srOnly	Sr only region of the component.	Part
toggleSwitchGroup	Toggle switch group region of the component.	Part

Variants & States

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

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <ToggleSwitch {...props}>
        {props.children || 'Example toggleswitch content'}
      </ToggleSwitch>
    </div>
  );
}

Open Sandbox

API Reference

Props

Name	Type	Required	Default	Description
`checked`	`boolean`	Yes	`{value`	—
`disabled`	`boolean`	No	`false`	—
`onChange`	`(e: React.ChangeEvent<HTMLInputElement>) => void`	Yes	`{handler`	—
`children`	`ReactNode`	Yes	`== 'string') {`	—
`id`	`string`	No	`{safeId`	—
`ariaLabel`	`string`	No	—	—
`ariaDescription`	`string`	No	—	—
`size`	`'small' \| 'medium' \| 'large'`	No	`'medium'`	—
`className`	`string`	No	`''`	—

Accessibility

Standards Compliance

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

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

Simple implementation with default props and common configurations.

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

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <ToggleSwitch {...props}>
        {props.children || 'Example toggleswitch content'}
      </ToggleSwitch>
    </div>
  );
}

Open Sandbox

Advanced Usage

Complex patterns including composition, state management, and real-world scenarios.

import React from 'react';

export default function App() {
  return (
    <div style={{ 
      padding: '2rem', 
      display: 'flex',
      flexDirection: 'column',
      gap: '1.5rem'
    }}>
      <h3>ToggleSwitch - Advanced Patterns</h3>
      <p>Advanced usage patterns for ToggleSwitch include:</p>
      <ul>
        <li>Composition with other components</li>
        <li>Custom styling and theming</li>
        <li>Controlled vs uncontrolled patterns</li>
        <li>Form integration</li>
        <li>Accessibility enhancements</li>
      </ul>
      <p style={{ color: '#6b7280', fontStyle: 'italic' }}>
        Full advanced examples coming soon.
      </p>
    </div>
  );
}

Open Sandbox

Development Tools

Use these tools to analyze the component's performance, design tokens, and accessibility during development.

Contribute

Help us improve the ToggleSwitch component documentation. Found an issue or have suggestions?

Edit this page Report an issue Contribution guidelines

ToggleSwitch

Overview

Purpose

When to Use

When Not to Use

Live Example

Anatomy

Variants & States

API Reference

Props

Accessibility

Standards Compliance

Accessibility Checklist

Usage Guidelines

Do

Don't

Examples

Basic Usage

Advanced Usage

Development Tools

Contribute

Related Components

Calendar

Checkbox

CheckboxGroup

ColorPicker

DatePicker

FileInput