Checkbox component for React native
Switch branches/tags
Nothing to show
Clone or download
sconxu Merge pull request #75 from b8ne/issue-56
Fix prop return value
Latest commit 2f819ce Apr 2, 2018

README.md

react-native-checkbox

Checkbox component for React native

Installation:

Install the component through npm using:

npm install react-native-checkbox --save

Example:

import CheckBox from 'react-native-checkbox';

<CheckBox
  label='Label'
  checked={true}
  onChange={(checked) => console.log('I am checked', checked)}
/>

Props:

  • label : text that will be displayed along the checkbox
  • labelBefore : position the label before the checkbox (boolean). The default value is false
  • labelStyle : style object that will be applied to the label
  • checked : initial checked value
  • checkedImage: checked image (e.g.: require('PATH_TO_IMAGE'))
  • checkboxStyle : style object that will be applied to the checkbox
  • uncheckedImage: unchecked image (e.g.: require('PATH_TO_IMAGE'))
  • onChange : callback function that will be invoked with the toggled checked property as argument.
  • containerStyle : style object that will be applied to the container
  • underlayColor : style the touchable component underlay color
  • accessible : indicates whether view is an accessible element
  • accessibilityLabel : maps to content description / label for Android automation
  • testID : maps to id / name for iOS automation