Skip to content
Binary UIKit reference Stable

Checkbox

Bindable tri-state checkbox with a visible or ARIA-only accessible name.

Choose Checkbox for an independent option or multi-selection. New code supplies exactly one accessible name through `label`, `aria-label`, or `aria-labelledby`. The optional-label branch exists only for source compatibility with 0.19. Do not create an unnamed control.

Interactive example

Loading interactive example

API

Inherited prop contracts

  • AccessibleName Requires exactly one accessible name: label, aria-label, or aria-labelledby.
  • LegacyOptionalLabelCheckbox This shared prop contract also applies.
MemberTypeKindRequiredDefault
aria-labelstringpropNoundefined
aria-labelledbystringpropNoundefined
checkedbooleanbindingNofalse
disabledbooleanpropNofalse
indeterminatebooleanbindingNofalse
labelstringpropNoundefined
onCheckedChange(checked: boolean) => voidcallbackNoundefined
sizeControlSizepropNo'md'

Source

Loading source