Installation
Add the dependency:
npm i react-native-bouncy-checkbox-group
Peer Dependencies
IMPORTANT! You need install them
"react-native-bouncy-checkbox": ">= 4.0.0"
Usage
Import
import BouncyCheckboxGroup, {
CheckboxButton,
} from "react-native-bouncy-checkbox-group";
Fundamental Usage
<BouncyCheckboxGroup
data={staticData}
onChange={(selectedItem: CheckboxButton) => {
console.log("SelectedItem: ", JSON.stringify(selectedItem));
}}
/>
Vertical Usage
<BouncyCheckboxGroup
data={verticalStaticData}
style={{ flexDirection: "column" }}
onChange={(selectedItem: CheckboxButton) => {
console.log("SelectedItem: ", JSON.stringify(selectedItem));
}}
/>
Data Format
You MUST follow this data format as CheckboxButton
[
{
id: 0,
},
{
id: 1,
},
{
id: 2,
},
{
id: 3,
},
];
Example Project 😍
You can checkout the example project 🥰
Simply run
npm i
react-native run-ios/android
should work of the example project.
Configuration - Props
Fundamentals
Property | Type | Default | Description |
---|
data | ICheckboxButton[] | undefined | set the checkboxes as a data |
onChange | function | undefined | set your own logic when the group of checkbox is selected |
checkboxProps | IBouncyCheckboxProps | undefined | default props for all checkboxes |
initial | number | undefined | default selected item (id of selection object) |
Customization (Optionals)
You can use all of the customiztion options from the rn bouncy checkbox. You NEED to add the styling and props into the data
. Therefore, you can customize each of the checkboxes easily.
Future Plans
Author
FreakyCoder, kurayogun@gmail.com
License
React Native Bouncy Checkbox Group is available under the MIT license. See the LICENSE file for more info.