@react-native-community/checkbox

Note: checkbox doesn't support iOS. Please use Switch for iOS. If you think it is necessary to support iOS, please discuss here

React Native component used to select a single value from a range of values.

Support

Getting started

yarn add @react-native-community/checkbox

or

npm install @react-native-community/checkbox --save

Mostly automatic installation

From react-native >= 0.60 autolinking will take care of the link, just don't forget to run pod install after adding this pakage

for react-native =< 0.59.X

react-native link @react-native-community/checkbox

Manual installation

include ':react-native-community-checkbox'
project(':react-native-community-checkbox').projectDir = new File(rootProject.projectDir, '../node_modules/@react-native-community/checkbox/android')

dependencies {
   ...
   implementation project(':react-native-community-checkbox')
}

import com.reactnativecommunity.checkbox.ReactCheckBoxPackage;

@Override
protected List<ReactPackage> getPackages() {
    return Arrays.asList(
            new MainReactPackage(),
            new ReactCheckBoxPackage()
    );
}

Migrating from the core react-native module

This module was created when the CheckBox was split out from the core of React Native. To migrate to this module you need to follow the installation instructions above and then change you imports from:

import { CheckBox } from 'react-native';

to:

import CheckBox from '@react-native-community/checkbox';

Usage

Example

import CheckBox from '@react-native-community/checkbox';

  <CheckBox
    value={true}
    disabled={false}
  />

Check out the example project for more examples.

Props

View props...

Contributors

This module was extracted from react-native core.

License

The library is released under the MIT licence. For more information see LICENSE.