Skip to content

hubertjaruzal/ReactNative-checkbox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReactNative-checkbox

Checkbox and CheckboxList Components for React Native. Components uses MaterialIcons from https://github.com/oblador/react-native-vector-icons.

Installation

npm i ReactNative-checkbox --save

iOS

  • Browse to node_modules/react-native-vector-icons and drag the folder Fonts (or just the ones you want) to your project in Xcode.

  • Edit Info.plist and add:

<key>UIAppFonts</key>
<array>
  <string>Entypo.ttf</string>
  <string>EvilIcons.ttf</string>
  <string>FontAwesome.ttf</string>
  <string>Foundation.ttf</string>
  <string>Ionicons.ttf</string>
  <string>MaterialIcons.ttf</string>
  <string>Octicons.ttf</string>
  <string>Zocial.ttf</string>
</array>

Usage:

import {Checkbox, CheckboxList } from 'ReactNative-checkbox';

render() {
  const Items = [
    {name: 'Item1', done: true},
    {name: 'Item2', done: true},
    {name: 'Item4', done: false}
  ];

  return (
    <View style={styles.container}>
      <CheckboxList
        data={Items}
        checked='done'
        iconColor='#4078c0'
        iconChecked='check-box'
        iconUnchecked='check-box-outline-blank'
      />
    </View>
  );
}

Example

#Props:

Checkbox

  • checked : Boolean
  • iconUnchecked : Name for unchecked icon from MaterialIcons (https://design.google.com/icons/) ex. "radio-button-unchecked".
  • iconChecked : Name for checked icon from MaterialIcons (https://design.google.com/icons/) ex. "radio-button-checked".
  • iconColor : String ex. "#305dc1".
  • iconSize : Number
  • text : Text that will be displayed along the checkbox.
  • textSize : Number - fontSize value.
  • onChange : Function that will be executed after click on checkbox.
  • checkboxStyles : StyleSheet abstraction ex. { flexDirection: 'row', flexWrap: 'wrap', alignItems: 'center'}
  • iconStyles : StyleSheet abstraction ex. { marginRight: 5 }

CheckboxList

  • checked : String - Name of the object property which stands for checked (boolean).
  • name : String - Name of the object property which stands for name. It will be displayed along the checkbox.
  • data : Array of objects ex. [{name: 'Female', checked: true}, {name: 'Male', checked: false}]
  • iconUnchecked : Name for unchecked icon from MaterialIcons (https://design.google.com/icons/) ex. "radio-button-unchecked".
  • iconChecked : Name for checked icon from MaterialIcons (https://design.google.com/icons/) ex. "radio-button-checked".
  • iconColor : String ex. "#305dc1".
  • iconSize : Number
  • textSize : Number - fontSize value.
  • onChange : Function that will be executed after click on checkbox.
  • checkboxStyles : StyleSheet abstraction ex. { flexDirection: 'row', flexWrap: 'wrap', alignItems: 'center'}
  • iconStyles : StyleSheet abstraction ex. { marginRight: 5 }
  • checkboxListStyles : StyleSheet abstraction ex. { flex: 1 }

About

Checkbox Components for React Native

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published