/react-native-check-box

Checkbox component for react native, it works on iOS and Android.

Primary LanguageJavaScriptMIT LicenseMIT

react-native-check-box

release PRs Welcome NPM version License MIT

Checkbox component for react native, it works on iOS and Android.

Content

Installation

  • 1.Run npm i react-native-check-box --save
  • 2.import CheckBox from 'react-native-check-box'

Demo

Screenshots

Getting started

Add react-native-check-box to your js file.

import CheckBox from 'react-native-check-box'

Inside your component's render method, use CheckBox:

<CheckBox
    style={{flex: 1, padding: 10}}
    onClick={()=>this.onClick(data)}
    isChecked={data.checked}
    leftText={leftText}
/>;

Then you can use it like this:

Basic usage

 <CheckBox
     style={{flex: 1, padding: 10}}
     onClick={()=>this.onClick(data)}
     isChecked={data.checked}
     leftText={leftText}
 />;

Custom CheckBox

renderCheckBox(data) {
    var leftText = data.name;
    return (
        <CheckBox
            style={{flex: 1, padding: 10}}
            onClick={()=>this.onClick(data)}
            isChecked={data.checked}
            leftText={leftText}
            checkedImage={<Image source={require('../../page/my/img/ic_check_box.png')} style={this.props.theme.styles.tabBarSelectedIcon}/>}
            unCheckedImage={<Image source={require('../../page/my/img/ic_check_box_outline_blank.png')} style={this.props.theme.styles.tabBarSelectedIcon}/>}
        />);
}

More Usage:

GitHubPopular

API

Props Type Optional Default Description
style View.propTypes.style true Custom style checkbox
leftText React.PropTypes.string true Custom left Text
leftTextStyle Text.propTypes.style true Custom left Text style
rightText React.PropTypes.string true Custom right Text
rightTextView React.PropTypes.element true Custom right TextView
rightTextStyle Text.propTypes.style true Custom right Text style
checkedImage React.PropTypes.element true Default image Custom checked Image
unCheckedImage React.PropTypes.element true Default image Custom unchecked Image
isChecked React.PropTypes.bool false false checkbox checked state
onClick React.PropTypes.func.isRequired false callback function

Contribution

Issues are welcome. Please add a screenshot of bug and code snippet. Quickest way to solve issue is to reproduce it on one of the examples.

Pull requests are welcome. If you want to change API or making something big better to create issue and discuss it first.


MIT Licensed