https://github.com/sconxu/react-native-checkbox

Checkbox component for React native
https://github.com/sconxu/react-native-checkbox

Last synced: about 1 month ago
JSON representation

Checkbox component for React native

• Host: GitHub
• URL: https://github.com/sconxu/react-native-checkbox
• Owner: sconxu
• Created: 2015-09-29T08:05:45.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-04-18T14:38:09.000Z (over 4 years ago)
• Last Synced: 2024-11-29T00:33:44.370Z (about 2 months ago)
• Language: JavaScript
• Size: 50.8 KB
• Stars: 172
• Watchers: 7
• Forks: 101
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-react-native - react-native-checkbox ★154 - Checkbox component for React native (Components / UI)
• awesome-reactnative-ui - react-native-checkbox
• awesome-react-native - react-native-checkbox ★154 - Checkbox component for React native (Components / UI)
• awesome-reactnative-ui - react-native-checkbox
• awesome-react-native - react-native-checkbox ★154 - Checkbox component for React native (Components / UI)
• awesome-react-native-ui - react-native-checkbox ★74 - Checkbox component for React native (Components / UI)
• awesome-react-native - react-native-checkbox ★154 - Checkbox component for React native (Components / UI)

README

        
# react-native-checkbox

Checkbox component for React native

## Installation:

Install the component through npm using:

```

npm install react-native-checkbox --save

```

## Example:

```js

import CheckBox from 'react-native-checkbox';

 console.log('I am checked', checked)}

/>

```

## Props:

- `label` : text that will be displayed along the checkbox

- `labelBefore` : position the label before the checkbox (boolean). The default

value is false

- `labelStyle` : style object that will be applied to the label

- `checked` : initial checked value

- `checkedImage`: checked image (e.g.: require('PATH_TO_IMAGE'))

- `checkboxStyle` : style object that will be applied to the

  checkbox

- `uncheckedImage`: unchecked image (e.g.: require('PATH_TO_IMAGE'))

- `onChange` : callback function that will be invoked with the toggled checked property as argument.

- `containerStyle` : style object that will be applied to the

  container

- `underlayColor` : style the touchable component underlay color

- `accessible` : indicates whether view is an accessible element

- `accessibilityLabel` : maps to content description / label for Android automation

- `testID` : maps to id / name for iOS automation