Prepare

The prepare component can be found under the Sybrin.Biometrics namespace and is called PrepareComponent.

Full name: Sybrin.Biometrics.PrepareComponent.

It is a component that provides an initial preparation screen, providing an easy way to view a customizable privacy policy and usage guidelines.

With default styling, the prepare component appears as follows:

Upon clicking "View Our Privacy Policy", the onViewPrivacyPolicy event will fire. Hooking onto this event allows you to react to the button click and show your privacy policy.

Upon clicking "View Guidelines", the component will automatically open a new window and display guidelines for taking a selfie. The onViewGuidelines event will also fire, allowing you to run additional code if needed.

Clicking "Take Selfie" will result in the onTakePhoto event firing, which can then be used as a signal to initialize the passive component, or the device select component first should the user system possess multiple viable video input devices.

If the component is configured to allow for mobile capture and the flow is being executed on a desktop web browser, the "Mobile Capture" button will be available. Clicking on "Mobile Capture" will cause the onMobileCaptureStart event to fire. This can then be used as a trigger to generate a mobile ID and signal for the prepare component to present a scannable QR code and a URL by invoking the initializeMobileCaptureWithId function. This will result in the following:

Initialization

The prepare component can be initialized using the following code:

<div id='prepare'></div>

// Option 1: Passing an id
var component = new Sybrin.Biometrics.PrepareComponent({ 
    id: 'prepare',
});

// Option 2: Passing a DOM element
var element = document.getElementById('prepare');
var component = new Sybrin.Biometrics.PrepareComponent({ 
    element: element
});

component.initialize();

The Sybrin Web SDK provides the option to either pass down the ID of the element you wish to use for component initialization, or to pass the element directly.

Please note that 'prepare' is just an example in this context and the ID may be changed as desired as long as it matches the value passed down during component initialization in JavaScript.

During initialization, the prepare component allows for a number of configuration options that may be passed down using an object literal. The parameters that may be used on the object include the following:

Required:

id (string): ID of the element you wish to use for component initialization. Not required if element is passed.
element (HTMLElement): Element you wish to use for component initialization. Not required if id is passed.

Optional:

enableMobileCapture (boolean): A flag that sets whether or not mobile capture should be enabled. If it is set to true and the flow is being executed on a desktop browser, the "Mobile Capture" button will be visible.
flowDirection (number): This property is used to control the flow direction of the guidelines window. 0 is left to right. 1 is right to left. Default 0
translations ({ [key: string]: string }): An object literal representing a dictionary lookup that will be used for translating the component. Please see the translations section on this page for a list of all translatable text, as well as the localization page for a detailed description on how to implement localization.

Warning: Initialization will fail if the intended host element does not exist yet.

Always ensure that the initialize function is only called after the DOM is loaded.

Destruction

The prepare component may be removed from the UI by calling the destroy() function on it.

Example:

component.destroy();

Functions

Initialize

initialize(): void

Initializes the component's DOM and events.

Destroy

destroy(): void

Destroys the component's DOM and events.

Set Translations

setTranslations(translations?: { [key: string]: string; }): void

Changes the component's translations to the provided values and updates the DOM accordingly.

Set Flow Direction

setFlowDirection(flowDirection: FlowDirection): void

Changes the component's flow direction.

Initialize Mobile Capture With ID

initializeMobileCaptureWithId(mobileId: string): void

Switches the component to mobile mode with a generated URL using the provided ID.

Events

The prepare component offers multiple events. To hook onto an event, simply assign a function to it.

The following options are available:

onMobileCaptureStart()
onMobileCaptureCancel()
onTakePhoto()
onViewPrivacyPolicy()
onViewGuidelines()

On Mobile Capture Start

This function is called when the "Mobile Capture" button is clicked. To hook onto the event, you may use the following code:

component.onMobileCaptureStart = function() {
    console.log('Mobile Capture clicked!');
}