techmentormaria / react-native-item-checkbox

Create your own item checkbox with custom colors.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

react-native-item-checkbox

Create your own item checkbox with custom colors.

Getting started

npm i react-native-item-checkbox

!IMPORTANT only works with react-native-vector-items now Don't forget to run rnpm link

Basic usage

This basic line will generate a standard checkbox with a 'check' symbol for you.

Options

Option default value values
onCheck (PropTypes.func) function that alerts 'implement me' callback function
onUncheck (PropTypes.func) function that alerts 'implement me' callback function
icon (PropTypes.String) 'check' any FontAwesome icon you find here
size (PropTypes.number) 18 the size of your checkbox button
backgroundColor (PropTypes.String) 'grey' colors
color (PropTypes.String) 'white' colors
iconSize (PropTypes.String) 'normal' {'small', 'normal', 'large'}
checked (PropTypes.bool) false {true, false} (calles onCheck or onUncheck)
default (PropTypes.bool) false {true, false} (doesn't call onCheck or onUncheck)
style (PropTypes.func) null custom style

Examples

var ItemCheckbox = require('react-native-item-checkbox');

// inside your render function
<ItemCheckbox /> // 

Gif

// ...
_onCheckCallback: function() {
  alert('checked');
},
// ...
<ItemCheckbox //example with callbacks
  onCheck={this._onCheckCallback}
/>
<ItemCheckbox //example with icon settings
  color="#FF9999"
  icon="tree"
  iconSize="normal" //"small", "normal", "large"
  size={100}
/>

Gif

iconSize

Gif

iconSize={"small", "normal", "large"}

About

Create your own item checkbox with custom colors.

License:MIT License


Languages

Language:JavaScript 100.0%