0.0.8 • Published 6 years ago

check-box-react-native v0.0.8

Weekly downloads
4
License
MIT
Repository
github
Last release
6 years ago

check-box-react-native

NPM version Build Status

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

Content:

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:

PropsTypeOptionalDefaultDescription
styleView.propTypes.styletrueCustom style checkbox
leftTextReact.PropTypes.stringtrueCustom left text
leftTextStyleView.propTypes.styletrueCustom left style
rightTextReact.PropTypes.stringtrueCustom right text
rightTextStyleView.propTypes.styletrueCustom right style
checkedImageReact.PropTypes.elementtrueDefault imageCustom checked image
unCheckedImageReact.PropTypes.elementtrueDefault imageCustom unchecked image
isCheckedReact.PropTypes.booltruefalsePropTypes checkbox checked
onClickReact.PropTypes.func.isRequiredfalsecallback function
disabledReact.PropTypes.booltruefalseDisable 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