@idscan/onboarding 2.2.25 → 2.3.0

package/readme.md

@@ -66,11 +66,11 @@ All configurations of @idscan/IDVC will be fetched from DVS Online by domainId.
 
 Available fields:
 
-**el** (string) - id of an element on the page where the component will be integrated. Required.
+**el** (string) - Id of an element on the page where the component will be integrated. Required.
 
-**applicantId** (string) - id of applicant. Required.
+**applicantId** (string) - Id of applicant. Required.
 
-**domainId** (string) - domain id where from will get configs and styles. Required.
+**domainId** (string) - Domain id where from will get configs and styles. Required.
 
 **domainApi** (string) - URL address of onboarding API. Required.
 
@@ -92,25 +92,37 @@ Available fields:
 
 **processingImageFormat** (string) - This option switches image format, that used for image processing.
 
-**callbacks** (object) - object with callback hooks. Available next hooks:
+**demoMode** (boolean) - In true mode, the wrapper stops documents validation.
 
-- **onChange** - callback-function which will be called after change one step. The returnable value is the object with the type and the image.
+**wrapperSettings** (object) - Object with wrapper (not IDVC) settings. Allows you to override the config that came from the API. Available fields:
 
-- **onCameraError** - The function that is invoked in case if the camera is not available. The response value is the object with the error code and the message.
+- **showQrCode** - Enable validation on another device using a QR link.
 
-- **onReset** - callback-function which will be called after reset all the steps. The returnable value is the object with the steps.
+- **showConsentForm** - This option switches on/off the displaying consent form.
 
-- **onRetakeHook** - the function that will be called before reset the current step. The returnable value is the object with the current step.
+- **consentText** - This option allows you to set the body text of the consent form.
 
-- **onValidate** - the function that will be called after validation response received. The returnable value is the object with validation information.
+- **checkboxText** - This option allows you to set the confirmation text of the consent form.
 
-- **onError** - the function that will be called on error. The response value is the object with the error code and the message.
+**callbacks** (object) - Object with callback hooks. Available hooks:
 
-- **onReloaded** - the function that will be called after the component finishes reloading. This function doesn't return a value.
+- **onChange** - Callback-function which will be called after change one step. The returnable value is the object with the type and the image.
 
-- **onMounted** - the function that will be called on the component mounted. This function doesn't return a value.
+- **onCameraError** - Callback-function which is invoked in case if the camera is not available. The response value is the object with the error code and the message.
 
-- **submit** - callback-function which will be called after completing all the steps. The returnable value is the object with the following content:
+- **onReset** - Callback-function which will be called after reset all the steps. The returnable value is the object with the steps.
+
+- **onRetakeHook** - Callback-function which will be called before reset the current step. The returnable value is the object with the current step.
+
+- **onValidate** - Callback-function which will be called after validation response received. The returnable value is the object with validation information.
+
+- **onError** - Callback-function which will be called on error. The response value is the object with the error code and the message.
+
+- **onReloaded** - Callback-function which will be called after the component finishes reloading. This function doesn't return a value.
+
+- **onMounted** - Callback-function which will be called on the component mounted. This function doesn't return a value.
+
+- **submit** - Callback-function which will be called after completing all the steps. The returnable value is the object with the following content:
 ```javascript
 documentTypes: [
   {
@@ -161,6 +173,15 @@ btn.addEventListener('click', () => {
 **updateConfig** (string) - the method that reinitialize wrapper with new config. Parameter is an JSON encoded IDVC config. Works only in demo mode.
 
 ## Version history
+- **2.2.28**
+  - feat: added 'wrapperSettings' option that allows you to override the wrapper config that comes from the API. This option works if the 'preferApiConfig' option is set to false.
+
+- **2.2.27**
+  - Updated IDVC component
+
+- **2.2.26**
+  - Updated IDVC component
+  
 - **2.2.25**
   - Updated IDVC component
   - fix: wrapper config option 'el'