0.1.1 • Published 3 months ago
eight-auth v0.1.1
8x8 Authentication Widget
This webcomponent follows the open-wc recommendation.
Installation
npm i eight-authUsage
ES6 (Recommended)
import 'eight-auth'
// Use defined custom web component
<eight-auth
clientKey=""
defaultCountrySelected=""
bannerSrc=""
success=""
error=""
>
</eight-auth>UMD | CDN
index.html
<script type="module" src="<cdn-provider-url>/8x8/eight-auth.min.js"> </script>
<eight-auth
clientKey=""
defaultCountrySelected=""
bannerSrc=""
success=""
error=""
>
</eight-auth>CommonJS
require('eight-auth);
<eight-auth
clientKey=""
defaultCountrySelected=""
bannerSrc=""
success=""
error=""
>
</eight-auth>API Reference
| Properties | Description | Default | Required | |
|---|---|---|---|---|
| clientKey | A public API Key to initialize Authentication Widget on browser | "" | Yes | String |
| placeholder | Custom placeholder for mobile number input field | Enter Mobile Number | No | String |
| bannerSrc | Your custom logo in embedding Authentication Widget | "8auth.png" | Yes | String/URL/Path |
| exclude | Exclude certain countries in country code selection | "" | No | String |
| includeOnly | Include only certain countries in country code selection | "" | No | String |
| displayFlag | Option if user wanted opted to display or hide country flag icons. | true | No | Boolean |
| alertDelay | Timeout delay for on-scrreen error or success messages. Value should be in ms | 3000 | No | Integer |
| inputCharLimit | Max Length value for Mobile Number Input Field. | 20 | No | Integer |
| success | Redirect URL once OTP Verification is successful | Host URL | Yes | String/Url/Function |
| error | Callback handler if verification is unsuccessful or external service encountered an error | Error | Yes | String/Url/Function |
Theming
The Authentication Widget already has built-in config for light or dark mode options. As for individual module or component, this is not currently supported.
Contributing
Refer to 8x8 Code of Conduct and Best Practices.