axiom-verify
v1.0.0
Published
Axiom user verify widget library
Downloads
9
Readme
Installation:
AXIOM Verify - used to show the axiom protect 2.0 user login at the current page itself.
Use this script tag to get access to the widget.
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.min.js"></script>
Implementation:
Steps:-
Create or open an html file.
Add a button with the id
xxxx
. It is used to call the widget by on click event.
<button id="xxxx">Open</button>
- Add a div tag with the id
axiom-embedded-verify
at the last or beginning of the body tag. It is used to display the axiom module with the help of this id.
<div id="axiom-embedded-verify"></div>
- Add a Script tag to the head tag or body tag. And use the latest version.
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.min.js"></script>
- Next, add the script tag at a necessary place. But add below the widget script.
<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
operatorEmail: string, // axiom operator account details for token
operatorPassword: string, // axiom operator account details for token
appId: string, // app id can be taken from app available from your operator account
userId: string, // user id can be taken from app assigned to user
onResponse: function (data) {}, // callback function, when api response
onError: function (data) {}, // callback function, when api error
onClose: function (data) {} // callback function, when page close
};
// get the element used in the action button
var container = document.getElementById('xxxx');
// on click of element widget works
container.addEventListener('click', function () {
axiom_verify.AXIOMVerify(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 axiom_verify
module.
axiom_verify.AXIOMVerify(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
orfalse
). To toggle the widget page open or close.changeToPopup
is used to pass a boolean value (true
orfalse
). To toggle the widget as a popup or inline page.operatorEmail
should pass as a string value. It is used to get the JWT token and to proceed with your operator account.operatorPassword
should pass as a string value. It is used to get the JWT token and to proceed with your operator account.appId
should pass as a string value. It is used to login with a specific app.userId
should pass as a string value. It is used to get the token type and verify user.onResponse
is a callback function. It is getting called when the API gives a successful response. Return data is an object with its API endpoint and result.onError
is a callback function. It is getting called when the API gives an error message or at any configuration error. Return data is an object with its API endpoint and result.onClose
is a callback function. It is getting called when the page/popup gets closed. Return data is an object with its action and result.