CheckBox

Usage
import { CheckBox } from 'react-native-elements'
<CheckBox
title='Click Here'
checked={this.state.checked}
/>
<CheckBox
center
title='Click Here'
checked={this.state.checked}
/>
<CheckBox
center
title='Click Here'
checkedIcon='dot-circle-o'
uncheckedIcon='circle-o'
checked={this.state.checked}
/>
<CheckBox
center
title='Click Here to Remove This Item'
iconRight
iconType='material'
checkedIcon='clear'
uncheckedIcon='add'
checkedColor='red'
checked={this.state.checked}
/>
Props
iconTypecomponentcheckedsizeiconRightrightcentertitlecontainerStylewrapperStyletextStyleonLongPressonLongIconPressonPressonIconPresscheckedIconuncheckedIconcheckedColoruncheckedColorcheckedTitlefontFamily
Reference
iconType
Icon family, can be one of the following: simple-line-icon, zocial, octicon, material, material-community, ionicon, foundation, evilicon, entypo (required only if specifying an icon that is not from font-awesome)
| Type | Default |
|---|---|
| string | fontawesome |
component
Specify React Native component for main button (optional)
| Type | Default |
|---|---|
| React Native Component | TouchableOpacity |
checked
Flag for checking the icon (required)
| Type | Default |
|---|---|
| boolean | false |
size
Size of the checkbox
| Type | Default |
|---|---|
| number | 24 |
iconRight
Moves icon to right of text (optional)
| Type | Default |
|---|---|
| boolean | false |
right
Aligns checkbox to right (optional)
| Type | Default |
|---|---|
| boolean | false |
center
Aligns checkbox to center (optional)
| Type | Default |
|---|---|
| boolean | false |
title
Title of checkbox (required)
| Type | Default |
|---|---|
| string | none |
containerStyle
Style of main container (optional)
| Type | Default |
|---|---|
| object (style) | none |
wrapperStyle
Style of container that wraps the check box and text(optional)
| Type | Default |
|---|---|
| object (style) | none |
textStyle
Style of text (optional)
| Type | Default |
|---|---|
| object (style) | none |
onLongPress
onLongPress function for checkbox (optional)
| Type | Default |
|---|---|
| function | none |
onLongIconPress
onLongPress function for checkbox (optional)
| Type | Default |
|---|---|
| function | none |
onPress
onPress function for container (optional)
| Type | Default |
|---|---|
| function | none |
onIconPress
onPress function for checkbox (required)
| Type | Default |
|---|---|
| function | none |
checkedIcon
Default checked icon (Font Awesome Icon) (optional)
| Type | Default |
|---|---|
| string | check-square-o |
uncheckedIcon
Default checked icon (Font Awesome Icon) (optional)
| Type | Default |
|---|---|
| string | square-o |
checkedColor
Default checked color (optional)
| Type | Default |
|---|---|
| string | green |
uncheckedColor
Default unchecked color (optional)
| Type | Default |
|---|---|
| string | #bfbfbf |
checkedTitle
Specify a custom checked message (optional)
| Type | Default |
|---|---|
| string | none |
fontFamily
Specify different font family
| Type | Default |
|---|---|
| string | System font bold (iOS), Sans Serif Bold (android) |
