Merge pull request #40 from aprilmintacpineda/patch-1

Update README.md to reflect changes with disableBuiltInState

Author: WrathChaos

README.md

@@ -73,24 +73,25 @@ import BouncyCheckbox from "react-native-bouncy-checkbox";
 
 ### Configuration - Props
 
-| Property             |   Type    |    Default     | Description                                                 |
-| -------------------- | :-------: | :------------: | ----------------------------------------------------------- |
-| text                 |  string   | undefined | set the checkbox's text                                     |
-| onPress              | function  |      null      | set your own onPress functionality after the bounce effect  |
-| disableText          |  boolean  |     false      | if you want to use checkbox without text, you can enable it |
-| size                 |  number   |       25       | size of `width` and `height` of the checkbox                |
-| style                |   style   |    default     | set/override the container style                            |
-| textStyle            |   style   |    default     | set/override the text style                                 |
-| iconStyle            |   style   |    default     | set/override the icon style                                 |
-| isChecked            |  boolean  |     false      | set the default checkbox value                              |
-| fillColor            |   color   |    #f09f48     | change the checkbox's filled color                          |
-| unfillColor          |   color   |  transparent   | change the checkbox's un-filled color when it's not checked |
-| useNativeDriver      |  boolean  |      true      | enable/disable the useNativeDriver for animation            |
-| iconComponent        | component |      Icon      | set your own icon component                                 |
-| checkIconImageSource |   image   |    default     | set your own check icon image                               |
-| ImageComponent       | component |     Image      | set your own Image component instead of RN's default Image  |
-| bounceEffect         |  number   |       1        | change the bounce effect                                    |
-| bounceFriction       |  number   |       3        | change the bounce friction                                  |
+| Property             |   Type    |    Default     | Description                                                                       |
+| -------------------- | :-------: | :------------: | ----------------------------------------------------------------------------------|
+| text                 |  string   | undefined | set the checkbox's text                                                                |
+| onPress              | function  |      null      | set your own onPress functionality after the bounce effect, callback receives the next `isChecked` boolean if disableBuiltInState is false |
+| disableText          |  boolean  |     false      | if you want to use checkbox without text, you can enable it                       |
+| size                 |  number   |       25       | size of `width` and `height` of the checkbox                                      |
+| style                |   style   |    default     | set/override the container style                                                  |
+| textStyle            |   style   |    default     | set/override the text style                                                       |
+| iconStyle            |   style   |    default     | set/override the icon style                                                       |
+| isChecked            |  boolean  |     false      | set the default checkbox value                                                    |
+| fillColor            |   color   |    #f09f48     | change the checkbox's filled color                                                |
+| unfillColor          |   color   |  transparent   | change the checkbox's un-filled color when it's not checked                       |
+| useNativeDriver      |  boolean  |      true      | enable/disable the useNativeDriver for animation                                  |
+| iconComponent        | component |      Icon      | set your own icon component                                                       |
+| checkIconImageSource |   image   |    default     | set your own check icon image                                                     |
+| ImageComponent       | component |     Image      | set your own Image component instead of RN's default Image                        |
+| bounceEffect         |  number   |       1        | change the bounce effect                                                          |
+| bounceFriction       |  number   |       3        | change the bounce friction                                                        |
+| disableBuiltInState  |  boolean  |     false      | if you want to manually handle the `isChecked` prop and disable built in handling |
 
 ## Synthetic Press Functionality with Manual Check State
 
@@ -101,7 +102,7 @@ import BouncyCheckbox from "react-native-bouncy-checkbox";
 
 Please check the `example-manual-state` runable project to how to make it work on a real project.
 
-<b><i>Becareful while using `disableBuiltInState` you MUST set the `isChecked` prop to use your own check state manually.</b></i>
+<b><i>Becareful while using `disableBuiltInState` you MUST set the `isChecked` prop to use your own check state manually.</b></i> The `onPress` callback will **NOT** receive the next `isChecked` when `disableBuiltInState` is used.
 
 Here is the basic implementation: