Skip to content

Commit

Permalink
README is updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@WrathChaos
WrathChaos committed Jun 19, 2020
1 parent bde1445 commit fa7d222
Showing 1 changed file with 21 additions and 22 deletions.
43 changes: 21 additions & 22 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ import BouncyCheckbox from "react-native-bouncy-checkbox";
unfillColor="white"
text="Custom Icon Example"
fontFamily="JosefinSans-Regular"
onPress={checked => console.log("Checked: ", checked)}
onPress={(checked) => console.log("Checked: ", checked)}
iconComponent={
<Image
style={{ height: 10, width: 10 }}
Expand All @@ -84,27 +84,26 @@ import BouncyCheckbox from "react-native-bouncy-checkbox";

### Configuration - Props

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

### Future Plans

Expand Down

0 comments on commit fa7d222

Please sign in to comment.