@trinsic/web-ui
v1.2.10
Published
Trinsic's Web UI SDK to easily launch your verifications and capture the result
Downloads
1,722
Readme
Trinsic Web UI Library
The Trinsic Web UI Library provides ways to launch verification sessions directly from your web frontend in the browser.
This library must be paired with an api library as part of a full integration.
Documentation
See the Trinsic docs for more detailed information on how to start integrating with our identity acceptance network.
Installation
Install the package with:
npm install @trinsic/web-ui
If you're using a CDN, for example unpkg, you can use the below source.
<script src="http://unpkg.com/@trinsic/web-ui"><script>
Usage
The library exports three methods: launchIframe(launchUrl)
, launchPopup(launchUrl)
and launchRedirect(launchUrl, redirectUrl)
.
When using a module bundler import the functions as follows:
import { launchIframe, launchRedirect, launchPopup } from "@trinsic/web-ui";
When using a direct script tag, you can access the methods via the global TrinsicUI
variable:
TrinsicUI.launchIframe();
You can retrieve the launch url from a trusted backend that can reach out to the Trinsic servers. See our API libraries.
You can find a full example using this library in the samples folder.
SDK Versioning
Our SDKs follow the Semantic Versioning ("SemVer") scheme.
For example, the version number 1.13.0
has a major version of 1
, a minor version of 13
, and a patch version of 0
.
Breaking changes are only introduced alongside a new major version.
Support
Any issues, inquiries, and feature requests can be sent to [email protected], or feel free to open a GitHub issue here.