Switch

The Switch is an alternative to the checkbox component.

import { Switch } from '@backyard-ui/core';

Use the size prop to increase the visual size.

To add a label or status message to your fields use the FormControl utility.

• size
  Description The Switch size

  Type

  "xs" | "sm" | "md"

  Default

  sm
• isChecked
  Description If `true`, the checkbox will be checked. You'll need to pass onChange to update its value (since it is now controlled)

  Type

  boolean
• asChild
  Description

  Type

  boolean
• isDisabled
  Description Set the form element to disabled

  Type

  boolean
• isInvalid
  Description Set the form element `aria-invalid` to `true`

  Type

  boolean
• isReadOnly
  Description Set the form element to readonly

  Type

  boolean
• isRequired
  Description Set the form element `aria-required` to `true`

  Type

  boolean