Skip to main content
Version: 0.60

CheckBox

Renders a boolean input (Android only).

This is a controlled component that requires an onValueChange callback that updates the value prop in order for the component to reflect user actions. If the value prop is not updated, the component will continue to render the supplied value prop instead of the expected result of any user actions.

@keyword checkbox @keyword toggle

Props#


Reference

Props#

disabled#

If true the user won't be able to toggle the checkbox. Default value is false.

TypeRequired
boolNo

onChange#

Used in case the props change removes the component.

TypeRequired
functionNo

onValueChange#

Invoked with the new value when the value changes.

TypeRequired
functionNo

testID#

Used to locate this view in end-to-end tests.

TypeRequired
stringNo

value#

The value of the checkbox. If true the checkbox will be turned on. Default value is false.

TypeRequired
boolNo