Skip to content

Commit cfa6b34

Browse files
committed
Version 2.0 library is here with much cleaner code and customization
1 parent a47fabd commit cfa6b34

File tree

1 file changed

+24
-26
lines changed

1 file changed

+24
-26
lines changed

README.md

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
Add the dependency:
2323

24-
### React Native:
24+
### React Native
2525

2626
```ruby
2727
npm i react-native-bouncy-checkbox
@@ -80,31 +80,29 @@ import BouncyCheckbox from "react-native-bouncy-checkbox";
8080

8181
### Configuration - Props
8282

83-
| Property | Type | Default | Description |
84-
| ---------------- | :-------: | :------------: | ----------------------------------------------------------- |
85-
| borderWidth | number | 1 | border width of the checkbox |
86-
| borderRadius | number | 20 | border radius of the checkbox |
87-
| borderColor | string | #ffc484 | border color of the checkbox |
88-
| color | string | #757575 | color of the text |
89-
| size | number | 25 | size of `width` and `height` of the checkbox |
90-
| isChecked | boolean | false | set the default checkbox value |
91-
| unfillColor | color | transparent | change the checkbox's un-filled color when it's not checked |
92-
| useNativeDriver | boolean | true | enable/disable the useNativeDriver for animation |
93-
| text | string | Call my mom 😇 | set the checkbox's text |
94-
| textColor | color | #757575 | change the text's color |
95-
| fontFamily | string | default | set your own font family |
96-
| fontSize | number | 16 | change the text's font size |
97-
| fillColor | color | #f09f48 | change the checkbox's filled color |
98-
| textStyle | object | default | set your own text style |
99-
| textDecoration | boolean | false | enable/disable text decoration for Text |
100-
| onPress | function | null | set your own onPress functionality after the bounce effect |
101-
| iconComponent | component | Icon | set your own icon component |
102-
| iconStyle | object | default | set your own icon style |
103-
| checkImageSource | image | default | set your own check icon image |
104-
| checkImageWidth | number | 10 | change the check icon's width |
105-
| checkImageHeight | number | 10 | change the check icon's height |
106-
| ImageComponent | component | Image | set your own Image component instead of RN's default Image |
107-
| disableText | boolean | false | if you want to use checkbox without text, you can enable it |
83+
| Property | Type | Default | Description |
84+
| -------------------- | :-------: | :------------: | ----------------------------------------------------------- |
85+
| borderWidth | number | 1 | border width of the checkbox |
86+
| borderRadius | number | 20 | border radius of the checkbox |
87+
| borderColor | string | #ffc484 | border color of the checkbox |
88+
| size | number | 25 | size of `width` and `height` of the checkbox |
89+
| isChecked | boolean | false | set the default checkbox value |
90+
| unfillColor | color | transparent | change the checkbox's un-filled color when it's not checked |
91+
| useNativeDriver | boolean | true | enable/disable the useNativeDriver for animation |
92+
| text | string | Call my mom 😇 | set the checkbox's text |
93+
| textColor | color | #757575 | change the text's color |
94+
| fontSize | number | 16 | change the text's font size |
95+
| fillColor | color | #f09f48 | change the checkbox's filled color |
96+
| textStyle | object | default | set your own text style |
97+
| textDecoration | boolean | false | enable/disable text decoration for Text |
98+
| onPress | function | null | set your own onPress functionality after the bounce effect |
99+
| iconComponent | component | Icon | set your own icon component |
100+
| iconStyle | object | default | set your own icon style |
101+
| checkIconImageSource | image | default | set your own check icon image |
102+
| checkImageWidth | number | 10 | change the check icon's width |
103+
| checkImageHeight | number | 10 | change the check icon's height |
104+
| ImageComponent | component | Image | set your own Image component instead of RN's default Image |
105+
| disableText | boolean | false | if you want to use checkbox without text, you can enable it |
108106

109107
### Future Plans
110108

0 commit comments

Comments
 (0)