Skip to main content
Version: 4.0.0-beta.0

CheckBox

CheckBoxes allow users to complete tasks that involve making choices such as selecting options, or switching settings - On or Off.

It provides a clear visual of either a true or false choice.

Usage


Props

CheckBox

Reference

CheckBox

Component

Specify React Native component for main button.

TypeDefault
React ComponentNone

center

Aligns checkbox to center.

TypeDefault
booleanfalse

checked

Flag for checking the icon.

TypeDefault
booleanfalse

checkedColor

Default checked color.

TypeDefault
stringColor(Primary)

checkedIcon

Default checked icon (Font Awesome Icon).

TypeDefault
anyNone

checkedTitle

Specify a custom checked message.

TypeDefault
stringNone

containerStyle

Style of main container.

TypeDefault
View style(Object)None

fontFamily

Specify different font family.

TypeDefault
stringNone

iconRight

Moves icon to right of text.

TypeDefault
booleanfalse

iconType

Type of icon set. Supported sets here.

TypeDefault
stringNone

onIconPress

onPress function for checkbox.

TypeDefault
FunctionNone

onLongIconPress

onLongPress function for checkbox.

TypeDefault
FunctionNone

Aligns checkbox to right.

TypeDefault
booleanfalse

size

Size of the checkbox.

TypeDefault
numberNone

textStyle

Style of text.

TypeDefault
Text Style(Object)None

title

Title of checkbox.

TypeDefault
anyNone

titleProps

Additional props for the title Text component.

TypeDefault
TextProps{}

uncheckedColor

Default unchecked color.

TypeDefault
stringNone

uncheckedIcon

Default checked icon (Font Awesome Icon)

TypeDefault
anyNone

wrapperStyle

Style for the wrapper of checkbox.

TypeDefault
View style(Object)None