rn-custom-checkbox v1.0.1
rn-custom-checkbox A customizable CheckBox screen component for React Native projects. Use this open source library in your fresh React Native project for instant startup.
Table of Contents
Installation
To use rn-custom-checkbox in your React Native project, simply install it using npm or yarn:
npm install rn-custom-checkbox
or
yarn add rn-custom-checkboxUsage
To use the CheckBox component in your app, import it from the rn-custom-checkbox package and render it as the second component in your app after splash screen. You can customize the appearance and behavior of the CheckBox by passing in props.
How to use
import CheckBox from "rn-custom-checkbox";
function App() {
return;
<CheckBox length={4} source={require("./src/assets/check.png")} />;
}Props
The CheckBox component accepts the following props:
| Prop Name | Data Type | Description |
|---|---|---|
| length | number | The number of checkboxes in the group |
| --------- | --------- | ---------------------------------------- |
| source | string | The image source for the checkbox icon |
| --------- | --------- | ---------------------------------------- |
| CheckBoxStyle | string | Style for individual checkboxes |
| --------- | --------- | ---------------------------------------- |
| containerStyle | string | Style for the container that holds the checkboxes |
| --------- | --------- | ---------------------------------------- |
| options | array | An array of options for the checkboxes |
| --------- | --------- | ---------------------------------------- |
| imageStyle | string | Style for the checkbox icon |
Contributors
We would like to thank the following developers for their contributions to this project:
To all our contributors, thank you for your hard work and dedication!
License
This package is released under the MIT License.