Skip to content

Commit fa7d222

Browse files
committed
README is updated
1 parent bde1445 commit fa7d222

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

README.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ import BouncyCheckbox from "react-native-bouncy-checkbox";
7272
unfillColor="white"
7373
text="Custom Icon Example"
7474
fontFamily="JosefinSans-Regular"
75-
onPress={checked => console.log("Checked: ", checked)}
75+
onPress={(checked) => console.log("Checked: ", checked)}
7676
iconComponent={
7777
<Image
7878
style={{ height: 10, width: 10 }}
@@ -84,27 +84,26 @@ import BouncyCheckbox from "react-native-bouncy-checkbox";
8484

8585
### Configuration - Props
8686

87-
| Property | Type | Default | Description |
88-
| --------------------- | :-------: | :------------: | --------------------------------------------------------------------- |
89-
| text | string | Call my mom 😇 | set the checkbox's text |
90-
| textColor | color | #757575 | change the text's color |
91-
| fontFamily | string | default | set your own font family |
92-
| fontSize | number | 16 | change the text's font size |
93-
| isChecked | boolean | false | set the default checkbox value |
94-
| checkboxSize | number | 25 | change the checkbox's size |
95-
| borderRadius | number | size/2 | change the checkbox's border radius if you do not want the circle one |
96-
| borderColor | color | #f09f48 | change the checkbox's border color |
97-
| fillColor | color | #f09f48 | change the checkbox's filled color |
98-
| unfillColor | color | transparent | change the checkbox's un-filled color when it's not checked |
99-
| iconComponent | component | Icon | set your own icon component |
100-
| onPress | function | null | set your own onPress functionality after the bounce effect |
101-
| iconSize | number | 15 | change the react-native-vector-icons' size |
102-
| iconName | string | check | change the react-native-vector-icons' name |
103-
| iconType | string | Entypo | change the react-native-vector-icons' type |
104-
| iconColor | string | #fdfdfd | change the react-native-vector-icons' color |
105-
| disableTextDecoration | boolean | false | enable/disable text decoration for Text |
106-
| useNativeDriver | boolean | true | enable/disable the useNativeDriver for animation |
107-
| textStyle | style | default | set your own text style |
87+
| Property | Type | Default | Description |
88+
| --------------------- | :-------: | :------------: | ----------------------------------------------------------- |
89+
| text | string | Call my mom 😇 | set the checkbox's text |
90+
| textColor | color | #757575 | change the text's color |
91+
| fontFamily | string | default | set your own font family |
92+
| fontSize | number | 16 | change the text's font size |
93+
| isChecked | boolean | false | set the default checkbox value |
94+
| checkboxSize | number | 25 | change the checkbox's size |
95+
| fillColor | color | #f09f48 | change the checkbox's filled color |
96+
| unfillColor | color | transparent | change the checkbox's un-filled color when it's not checked |
97+
| iconComponent | component | Icon | set your own icon component |
98+
| onPress | function | null | set your own onPress functionality after the bounce effect |
99+
| iconSize | number | 15 | change the react-native-vector-icons' size |
100+
| iconName | string | check | change the react-native-vector-icons' name |
101+
| iconType | string | Entypo | change the react-native-vector-icons' type |
102+
| iconColor | string | #fdfdfd | change the react-native-vector-icons' color |
103+
| disableTextDecoration | boolean | false | enable/disable text decoration for Text |
104+
| useNativeDriver | boolean | true | enable/disable the useNativeDriver for animation |
105+
| textStyle | style | default | set your own text style |
106+
| iconStyle | style | default | set your own icon style |
108107

109108
### Future Plans
110109

0 commit comments

Comments
 (0)