Function Checkbox

Parameters

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

  • OptionalariaLabel?: string

    Provide an accessible name for screen readers. Use this when label contains no readable text — e.g. when it renders only an icon, or when it is empty. It replaces the visible label for assistive technology.

    Example

    `Enable notifications`
    Copy

  • OptionalautoFocus?: boolean

    Automatically focus the checkbox when it is rendered to the UI

  • checked: CheckboxCheckedType

    The checked state of the checkbox. Supports an 'indeterminate' state in addition to true and false.

  • Optionaldisabled?: boolean

    Default

    false
    Copy

  • label: ReactNode

    Label displayed next to the checkbox. Required so the choice is explicit: the prop can't be omitted. The type still permits "empty" values, though — "", null, undefined, and false all render no label.

  • onCheckedChange: function

    • onCheckedChange(checked: boolean): void

      Called when the user toggles the checkbox.

      Parameters

      • checked: boolean

      Returns void