Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crazycodeboy/react-native-check-box

Checkbox component for react native, it works on iOS and Android.
https://github.com/crazycodeboy/react-native-check-box

check-box checkbox-component react-native react-native-checkbox

Last synced: 17 days ago
JSON representation

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

Awesome Lists containing this project

README 

        
# react-native-check-box



[ ![release](https://img.shields.io/github/release/crazycodeboy/react-native-check-box.svg?maxAge=2592000?style=flat-square)](https://github.com/crazycodeboy/react-native-check-box/releases)

[ ![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](https://github.com/crazycodeboy/react-native-check-box/pulls)

[ ![NPM version](http://img.shields.io/npm/v/react-native-check-box.svg?style=flat)](https://www.npmjs.com/package/react-native-check-box)

[![License MIT](http://img.shields.io/badge/license-MIT-orange.svg?style=flat)](https://raw.githubusercontent.com/crazycodeboy/react-native-check-box/master/LICENSE)



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



## Content



- [Installation](#installation)

- [Demo](#demo)

- [Getting started](#getting-started)

- [API](#api)

- [Contribution](#contribution)



## Changes



For React Native >= 0.54 use v2.1.2+, for React Native < 0.4.4 use v1.0.4



## Installation



* 1.Run `npm i react-native-check-box --save`

* 2.`import CheckBox from 'react-native-check-box'`    



## Demo  

* [Examples](https://github.com/crazycodeboy/react-native-check-box/tree/master/examples)



![Screenshots](https://raw.githubusercontent.com/crazycodeboy/react-native-check-box/master/examples/Screenshots/react-native-check-box-screenshots.gif)



## 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:   



```javascript

{

      this.setState({

          isChecked:!this.state.isChecked

      })

    }}

    isChecked={this.state.isChecked}

    leftText={"CheckBox"}

/>

```



Then you can use it like this:   



### Basic usage  



```javascript

{

      this.setState({

          isChecked:!this.state.isChecked

      })

    }}

    isChecked={this.state.isChecked}

    leftText={"CheckBox"}

/>

 ```



### Custom CheckBox   



```javascript

renderCheckBox(data) {

    var leftText = data.name;

    return (

        {

                 this.setState({

                     isChecked:!this.state.isChecked

                 })

               }}

            isChecked={this.state.isChecked}

            checkedImage={}

            unCheckedImage={}

        />);

}

```



**More Usage:**    



[GitHubPopular](https://github.com/crazycodeboy/GitHubPopular/blob/develop/js/page/my/CustomKeyPage.js)



## API



Props              | Type     | Optional | Default     | Description

----------------- | -------- | -------- | ----------- | -----------

style  | ViewPropTypes.style  | true |   |   Custom style checkbox

leftText | PropTypes.string |true |   | Custom left Text

leftTextStyle  |  Text.propTypes.style | true |  | Custom left Text style

rightText | PropTypes.string |true |   | Custom right Text

rightTextView | PropTypes.element | true |   | Custom right TextView

rightTextStyle  | Text.propTypes.style | true |  | Custom right Text style

checkedImage  |  PropTypes.element  | true  | Default image | Custom  checked Image

unCheckedImage  |  PropTypes.element  | true  |  Default image  | Custom  unchecked Image

isChecked  |  PropTypes.bool |  false  |  false  | checkbox checked state

onClick   |  PropTypes.func.isRequired |  false  |  | callback  function

disabled  |  PropTypes.bool            | true  |  false | Disable the checkbox button

checkBoxColor | PropTypes.string | true |   | Tint color of the checkbox image (this props is for both checked and unchecked state)

checkedCheckBoxColor | PropTypes.string | true |   | Tint color of the checked state checkbox image (this prop will override value of `checkBoxColor` for checked state)

uncheckedCheckBoxColor | PropTypes.string | true |   | Tint color of the unchecked state checkbox image (this prop will override value of `checkBoxColor` for unchecked state)



## 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**