Function Switch

Parameters

• props: {
      ariaLabel?: string;
      checked: boolean;
      disabled?: boolean;
      onCheckedChange(checked: boolean): void;
  }

  • OptionalariaLabel?: string

    Provide an accessible name for screen readers. The switch renders no visible label of its own, so set this unless a visible label is associated with it elsewhere.

    Example

    `Dark mode`
    Copy

  • checked: boolean

    The checked state of the switch.

  • Optionaldisabled?: boolean

    Default

    false
    Copy

  • onCheckedChange: function

    • onCheckedChange(checked: boolean): void

      Called when the user toggles the switch.

      Parameters

      • checked: boolean

      Returns void