Skip to content

Checkbox

Overview

Checkboxes allow users to select one or multiple options from a set.

checkbox gif

Properties

namedescriptiontypedefault
valueRequired. The value associated with the checkbox.T-
checkedRequired. Indicates whether the checkbox is checked.boolean-
onCheckRequired. Callback when the checkbox is checked.(value: T) => void-
labelEndContent displayed at the end of the label.ReactNode-
labelStartContent displayed at the start of the label.ReactNode-
checkedIconIcon displayed when checked.ReactNode-
sizeSize of the checkbox.number28
checkboxStyleCustom styles for the checkbox.ViewStyle-
errorColorColor of the error state.ColorValue-
borderColorBorder color when unchecked.ColorValue-
checkedBorderColorBorder color when checked.ColorValue-
checkedBackgroundColorBackground color when checked.ColorValue-
errorAnimationDurationDuration of error animation in milliseconds.number300