README

check-box-react-native

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

Content:

Installation
Getting started
API
Features
Contribution
License

Installation:

npm install check-box-react-native --save

Getting started:

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

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

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) => {
    const 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}
              />
            }
        />
    );
}

API:

Props	Type	Optional	Default	Description
style	View.propTypes.style	true		Custom style checkbox
leftText	React.PropTypes.string	true		Custom left text
leftTextStyle	View.propTypes.style	true	Custom left style
rightText	React.PropTypes.string	true		Custom right text
rightTextStyle	View.propTypes.style	true	Custom right 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	true	false	PropTypes checkbox checked
onClick	React.PropTypes.func.isRequired	false		callback function
disabled	React.PropTypes.bool	true	false	Disable the checkbox button

Features:

Create test.

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.

License:

MIT

Usage no npm install needed!