Update doc and version bump

documentation/v5/docs/numeric_format.md

@@ -260,3 +260,61 @@ import { NumericFormat } from 'react-number-format';
 - [See Common Props](/docs/props)
 
 **Other than this it accepts all the props which can be given to a input or span based on displayType you selected.**
+
+## Other exports
+
+With v5.0 we expose some more utils/hooks which can be used for customization or other utilities
+
+### numericFormatter `(numString: string, props: NumericFormatProps) => string`
+
+In some places we need to just format the number before we pass it down as value, or in general just to render it. In such cases `numericFormatter` can be used directly.
+
+**Parameters**
+
+1st. `numString`(non formatted number string)
+
+2nd. `props` (the format props applicable on numeric format)
+
+**Return**
+`formattedString` returns the formatted number.
+
+### removeNumericFormat `(inputValue: string, changeMeta: ChangeMeta, props: NumericFormatProps) => string`
+
+Most of the time you might not need this, but in some customization case you might wan't to write a patched version on top of removeNumericFormat.
+
+However for customization case its recommended to use `useNumericFormat` and patch the methods it returns, as lot of other handling is done in the hook.
+
+**Parameters**
+
+1st. `inputValue`: the value after user has typed, this will be formatted value with the additional character typed by user.
+
+2nd. `changeMeta`: This is the change information rnf sends internally, its basically the change information from the last formatted value and the current typed input value.
+
+The type is following
+
+```js
+{
+  from: {start: number, end: number},
+  to: {start: number, end: number},
+  lastValue: string
+}
+```
+
+3rd. `props`: all the numeric format props
+
+**Return**
+`numString` returns the number in string format.
+
+### getNumericCaretBoundary `(formattedValue: string, props: NumericFormatProps) => Array<boolean>`
+
+This method returns information about what all position in formatted value where caret can be places, it returns n+1 length array of booleans(where n is the length of formattedValue).
+
+Most of time you don't need this, but in case if you very specific usecase you can patch the function to handle your case.
+
+See more details on [Concept](https://s-yadav.github.io/react-number-format/docs/customization/#concept)
+
+### useNumericFormat: `(props: NumericFormatProps) => NumberFormatBaseProps`
+
+The whole numeric format logic is inside useNumericFormat hook, this returns all the required props which can be passed to `NumberFormatBase`. For customization you can use to patch methods returned by `useNumericFormat` and pass to `NumberFormatBase`.
+
+See more details in [Customization](https://s-yadav.github.io/react-number-format/docs/customization/)

documentation/v5/docs/pattern_format.md

@@ -106,3 +106,61 @@ Demo
 - [See Common Props](/docs/props)
 
 **Other than this it accepts all the props which can be given to a input or span based on displayType you selected.**
+
+## Other exports
+
+With v5.0 we expose some more utils/hooks which can be used for customization or other utilities
+
+### patternFormatter `(numString: string, props: PatternFormatProps) => string`
+
+In some places we need to just format the number before we pass it down as value, or in general just to render it. In such cases `patternFormatter` can be used directly.
+
+**Parameters**
+
+1st. `numString`(non formatted number string)
+
+2nd. `props` (the format props applicable on numeric format)
+
+**Return**
+`formattedString` returns the formatted number.
+
+### removePatternFormat `(inputValue: string, changeMeta: ChangeMeta, props: PatternFormatProps) => string`
+
+Most of the time you might not need this, but in some customization case you might wan't to write a patched version on top of removePatternFormat.
+
+However for customization case its recommended to use `usePatternFormat` and patch the methods it returns, as lot of other handling is done in the hook.
+
+**Parameters**
+
+1st. `inputValue`: the value after user has typed, this will be formatted value with the additional character typed by user.
+
+2nd. `changeMeta`: This is the change information rnf sends internally, its basically the change information from the last formatted value and the current typed input value.
+
+The type is following
+
+```js
+{
+  from: {start: number, end: number},
+  to: {start: number, end: number},
+  lastValue: string
+}
+```
+
+3rd. `props`: all the numeric format props
+
+**Return**
+`numString` returns the number in string format.
+
+### getPatternCaretBoundary `(formattedValue: string, props: PatternFormatProps) => Array<boolean>`
+
+This method returns information about what all position in formatted value where caret can be places, it returns n+1 length array of booleans(where n is the length of formattedValue).
+
+Most of time you don't need this, but in case if you very specific usecase you can patch the function to handle your case.
+
+See more details on [Concept](https://s-yadav.github.io/react-number-format/docs/customization/#concept)
+
+### usePatternFormat: `(props: PatternFormatProps) => NumberFormatBaseProps`
+
+The whole numeric format logic is inside usePatternFormat hook, this returns all the required props which can be passed to `NumberFormatBase`. For customization you can use to patch methods returned by `usePatternFormat` and pass to `NumberFormatBase`.
+
+See more details in [Customization](https://s-yadav.github.io/react-number-format/docs/customization/)

documentation/v5/docs/props.md

@@ -160,18 +160,14 @@ const MAX_LIMIT = 1000;
 
 **default**: false
 
-If value is passed as string representation of numbers (unformatted) then this should be passed as `true`.
+If value is passed as string representation of numbers (unformatted) and number is used in any format props like in prefix or suffix in numeric format and format prop in pattern format then this should be passed as `true`.
+
+**Note**: Prior to 5.2.0 its was always required to be passed as true when value is passed as string representation of numbers (unformatted).
 
 ```js
-import { NumericFormat } from 'react-number-format';
+import { PatternFormat } from 'react-number-format';
 
-<NumericFormat
-  type="text"
-  value="123456789"
-  valueIsNumericString={true}
-  decimalSeparator=","
-  displayType="input"
-/>;
+<PatternFormat format="+1 (###) ###-####" value="123456789" valueIsNumericString={true} />;
 ```
 
 <details>
@@ -194,7 +190,7 @@ import { NumericFormat } from 'react-number-format';
 This handler provides access to any values changes in the input field and is triggered only when a prop changes or the user input changes. It provides two arguments namely the [valueObject](quirks#values-object) as the first and the [sourceInfo](quirks#sourceInfo) as the second. The [valueObject](quirks#values-object) parameter contains the `formattedValue`, `value` and the `floatValue` of the given input field. The [sourceInfo](quirks#sourceInfo) contains the `event` Object and a `source` key which indicates whether the triggered change is due to an event or a prop change. This is particularly useful in identify whether the change is user driven or is an uncontrolled change due to any prop value being updated.
 
 :::info
-If you are using `values.value` which is non formatted value as numeric string. Make sure to pass valueIsNumericString to be true.
+If you are using `values.value` which is non formatted value as numeric string. Make sure to pass valueIsNumericString to be true if any of the format prop as number on it. See [valueIsNumericString](#valueisnumericstring-boolean) for more details.
 :::
 
 ```js

package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-number-format",
   "description": "React component to format number in an input or as a text.",
-  "version": "5.1.4",
+  "version": "5.2.0",
   "main": "dist/react-number-format.cjs.js",
   "module": "dist/react-number-format.es.js",
   "types": "types/index.d.ts",