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#
- Component
- center
- checked
- checkedColor
- checkedIcon
- checkedTitle
- containerStyle
- fontFamily
- iconRight
- iconType
- onIconPress
- onLongIconPress
- right
- size
- textStyle
- title
- titleProps
- uncheckedColor
- uncheckedIcon
- wrapperStyle
Reference#
CheckBox#
Component#
Specify React Native component for main button.
| Type | Default |
|---|---|
| React Component | None |
center#
Aligns checkbox to center.
| Type | Default |
|---|---|
| boolean | false |
checked#
Flag for checking the icon.
| Type | Default |
|---|---|
| boolean | false |
checkedColor#
Default checked color.
| Type | Default |
|---|---|
| string | Color(Primary) |
checkedIcon#
Default checked icon (Font Awesome Icon).
| Type | Default |
|---|---|
| any | None |
checkedTitle#
Specify a custom checked message.
| Type | Default |
|---|---|
| string | None |
containerStyle#
Style of main container.
| Type | Default |
|---|---|
| View style(Object) | None |
fontFamily#
Specify different font family.
| Type | Default |
|---|---|
| string | None |
iconRight#
Moves icon to right of text.
| Type | Default |
|---|---|
| boolean | false |
iconType#
Type of icon set. Supported sets here.
| Type | Default |
|---|---|
| string | None |
onIconPress#
onPress function for checkbox.
| Type | Default |
|---|---|
| Function | None |
onLongIconPress#
onLongPress function for checkbox.
| Type | Default |
|---|---|
| Function | None |
right#
Aligns checkbox to right.
| Type | Default |
|---|---|
| boolean | false |
size#
Size of the checkbox.
| Type | Default |
|---|---|
| number | None |
textStyle#
Style of text.
| Type | Default |
|---|---|
| Text Style(Object) | None |
title#
Title of checkbox.
| Type | Default |
|---|---|
| any | None |
titleProps#
Additional props for the title Text component.
| Type | Default |
|---|---|
| TextProps | {} |
uncheckedColor#
Default unchecked color.
| Type | Default |
|---|---|
| string | None |
uncheckedIcon#
Default checked icon (Font Awesome Icon)
| Type | Default |
|---|---|
| any | None |
wrapperStyle#
Style for the wrapper of checkbox.
| Type | Default |
|---|---|
| View style(Object) | None |