Switch

A wrapper around React Aria’s Switch component. Provides keyboard, pointer, and touch interaction with proper ARIA role and state management.

Add via CLI

npx @a2ra/cli add switch

{
  "type": "Switch",
  "props": {
    "label": "Dark mode",
    "name": "darkMode",
    "value": "on",
    "defaultSelected": false
  }
}

Prop	Type	Description
`label`	`string`	Visible label text
`isSelected`	`boolean`	Controlled on/off state
`defaultSelected`	`true` `false` default	Uncontrolled default
`isDisabled`	`true` `false` default	Disables the switch
`isReadOnly`	`true` `false` default	Prevents toggling
`isRequired`	`true` `false` default	Marks as required
`isInvalid`	`true` `false` default	Shows error styling
`validationBehavior`	`aria` default `native`	Validation strategy
`name`	`string`	Form field name
`value`	`string`	Value submitted when selected
`description`	`string`	Helper text shown below the label
`errorMessage`	`string`	Error text when `isInvalid` is true

Switch uses role="switch" so screen readers announce it as a toggle, not a checkbox.
value is the string submitted with the form when the switch is on (like a checkbox value).