sonic-widget 1.0.0

package/README.md

@@ -0,0 +1,76 @@
+## Installation:
+
+**Sonic Widget** - _used to show the axiom protect 2.0 at the current page itself._
+
+Use this script tag to get access to the widget.
+
+**_`<script src="https://cdn.jsdelivr.net/npm/sonic-widget@1.0.0/dist/index.min.js"></script>`_**
+
+## Implementation:
+
+**Steps:-**
+
+1. Create or open an html file.
+
+2. Add a button with the id **`xxxx`**. It is used to call the widget by on click event.
+
+```html
+<button id="xxxx">Open</button>
+```
+
+3. Add a div tag with the id **`sonic-web-widget`** at the last or beginning of the body tag. It is used to display the sonic module with the help of this id.
+
+```html
+<div id="sonic-web-widget"></div>
+```
+
+4. Add a Script tag to the head tag or body tag. And use the latest version.
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@1.0.0/dist/index.min.js"></script>
+```
+
+5. Next, add the script tag at a necessary place. But add below the widget script.
+
+```html
+<script>
+	const config = {
+		baseurl: string, // the base url of the backend server
+		showPage: boolean, // used to show the page or not
+		changeToPopup: boolean, // widget shows by popup modal default is false
+		ipInfoKey: string, // api key to detect vpn used or not from "ipInfo.io"
+		readyApiKey: string, // api key to detect passive liveliness from "ReadyApi"
+		accountId: string, // account can be taken from operator axiom account
+		userId: string, // user prospective data
+		userName: string, // user prospective data
+		email: string, // user prospective data
+		phone: string, // user prospective data
+		applicationNo: string, // user prospective data
+		onMessage: function (data) {}, // callback function, when api response message or error or any other actions
+	};
+	// get the element used in the action button 
+	var container = document.getElementById('xxxx');
+	// on click of element widget works
+	container.addEventListener('click', function () {
+		sonic.SonicWidget(config);
+	});
+</script>
+```
+
+_Here, the config variable is used to pass the data. And the container variable is to get the dom element of the id **`xxxx`** button and add it to the event listener. It checks if the button is clicked and sends the config object data to the **`sonic`** module.
+**`sonic.SonicWidget(config)`**_
+
+**Note:-**
+
+- _**`baseurl`** should pass as a string value. It is used as the base URL for API calls._
+- _**`showPage`** is used to pass a boolean value ( **`true`** or **`false`** ). To toggle the widget page open or close._
+- _**`changeToPopup`** is used to pass a boolean value ( **`true`** or **`false`** ). To toggle the widget as a popup or inline page._
+- _**`ipInfoKey`** should pass as a string value. It is used to detect vpn used or not from "ipInfo.io" with this api key._
+- _**`readyApiKey`** should pass as a string value. It is used to detect passive liveliness from "ReadyApi" with this api key._
+- _**`accountId`** should pass as a string value. It is used to get the JWT token and proceed with the operator account._
+- _**`userId`** should pass as a string value. It is used to create a application for onboard sonic kyc._
+- _**`userName`** should pass as a string value. It is used to create a application for onboard sonic kyc._
+- _**`email`** should pass as a string value. It is used to create a application for onboard sonic kyc._
+- _**`phone`** should pass as a string value. It is used to create a application for onboard sonic kyc._
+- _**`applicationNo`** should pass as a string value. It is used to create a application for onboard sonic kyc._
+- _**`onMessage`** is a callback function. It is getting called when the API gives a message or at any configuration error. Return data is an object with its API endpoint and result._