1.0.8 • Published 4 years ago

@react-native-form/checkbox v1.0.8

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

@react-native-form/checkbox 🥳

Supports IOS Supports Android MIT License npm version npm downloads

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

IOS DefaultIOS Label LeftIOS Native Component
IOS DefaultIOS Left LabelIOS Native Component
Android DefaultAndroid Label LeftAndroid Native Component
Android DefaultAndroid Left LabelAndroid Native Component

Getting started

yarn add @react-native-form/checkbox

or

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

NOTE: This module must have react-native-vector-icons installed to work. 😜

Usage

Example

import Checkbox from '@react-native-form/checkbox';
 <Checkbox
    label="Red Rising"
    positionLabel="right"
    marginTop={0}
    nativeComponent={false}
    color="#457afb"
    disabled={false}
    checked={false}
    labelStyle={{}}
    containerStyle={{}}
    checkboxStyle={{}}
    switchStyle={{}}
    onValueChange={item => console.log(item)}
    value={13}
  />

Props

Prop nameDescriptionDefault
labelThe label of the checkbox. Can be string or componente.''
nativeComponentIf true the checkbox component is the Switch component, if else the checkbox is a RN component. Presents changes only on IOS.false
disabledIf true the user won't be able to toggle the checkbox.false
checkedIf true the checkbox will be started active.false
valueThe value of the checkbox.null
onValueChangeInvoked with the new { checked: boolean, label: string, value: any } value when the checkbox it changes.() => {}
colorThe color displayed when checkbox is on.#457afb
positionLabelThe position of the label. Must be left or right.right
marginTopThe margin top of the container.0
labelStyleThe custom style of the label.{}
containerStyleThe custom style of the container.{}
checkboxStyleThe custom style of the checkbox.{}
switchStyleThe custom style of the switch.{}

License

The library is released under the MIT licence