Switch

Copy Markdown

Usage

import { Switch } from "@raystack/apsara";

Switch Props

Examples

State

The Switch component supports various states to handle different interaction scenarios.

<Flex gap="large" align="center">
  <Switch />
  <Switch defaultChecked />
  <Switch disabled />
  <Switch disabled defaultChecked />
  <Switch required />
</Flex>

Size Variants

The Switch component comes in two sizes: large (default) and small.

<Flex gap="large" align="center">
  <Switch size="large" />
  <Switch size="large" defaultChecked />
  <Switch size="small" />
  <Switch size="small" defaultChecked />
</Flex>

Controlled Usage

Use the Switch component in a controlled manner to manage its state externally.

(function ControlledSwitch() {
  const [checked, setChecked] = React.useState(false);
  return <Switch checked={checked} onCheckedChange={setChecked} />;
})

Accessibility

The Switch component follows WAI-ARIA guidelines for toggle buttons:

• Uses proper ARIA attributes (aria-checked, aria-required, aria-label)
• Supports keyboard navigation (Space and Enter to toggle)
• Includes proper labeling and description support
• Changes cursor to 'not-allowed' when disabled
• Associates labels with the switch using htmlFor