Prepare
Last updated
Last updated
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:
The prepare component can be initialized using the following code:
The Sybrin Web SDK provides the option to either provide the ID of the element you wish to use for component initialization, or to provide 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 provided during component initialization in JavaScript.
During initialization, the prepare component allows for a number of configuration options that may be provided 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 provided.
element (HTMLElement)
: Element you wish to use for component initialization. Not required if id
is provided.
Optional:
api (Sybrin.Biometrics.Api)
: Optionally, the Sybrin.Biometrics.Api instance that the Prepare component should use internally.
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.
readonlyMode (boolean)
: A flag that sets whether or not the component should be in read only mode. If set to true, button events will be disabled. Default false
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.
The prepare component may be removed from the UI by calling the destroy()
function on it.
Example:
initialize(): void
Initializes the component's DOM and events.
destroy(): void
Destroys the component's DOM and events.
setTranslations(translations?: { [key: string]: string; }): void
Changes the component's translations to the provided values and updates the DOM accordingly.
initializeMobileCaptureWithId(mobileId: string, baseUrl?: string, fullUrl?: string): void
Switches the component to mobile mode with a generated URL using the provided ID. Optionally, a base URL or a full URL may be provided to override default behavior. A base URL will continue to use the mobile ID, but replace the base URL with the provided value. A full URL will replace the entire generated URL with the value that was provided.
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()
This function is called when the "Mobile Capture" button is clicked. To hook onto the event, you may use the following code:
No parameter is passed to this function call.
This function is called when the "Cancel" button is clicked while the component is in the mobile capture state. To hook onto the event, you may use the following code:
No parameter is passed to this function call.
This function is called when the "Take Selfie" button is clicked. To hook onto the event, you may use the following code:
No parameter is passed to this function call.
This function is called when the "View Our Privacy Policy" button is clicked. To hook onto the event, you may use the following code:
No parameter is passed to this function call.
The prepare component is structured a follows:
The classes and elements specified above may be used to freely style the prepare component as desired. To do so, simply create a stylesheet and include it in the project, then style according to the above classes and elements.
Styling implementation example:
This component is affected by the following translation keys:
sy-b-translation-1
Prompt text with explanation regarding selfie
Your selfie will be encrypted and stored in our digital vault.
sy-b-translation-2
Caption of the button that triggers the event to view privacy policy
View Our Privacy Policy
sy-b-translation-5
Caption of the button that proceeds to the next step
Next
sy-b-translation-6
Title displayed within the guidelines block
Selfie Guidelines
sy-b-translation-9
Lighting conditions guideline
Ensure well-balanced lighting
sy-b-translation-10
Accessories guideline
Remove hats, sunglasses and headsets
sy-b-translation-12
Positioning guideline
Position face in frame
sy-b-translation-13
Multiple faces guideline
Only one face must be in frame
sy-b-translation-36
Scan QR instruction that is displayed when the component is in mobile capture mode
Using your mobile device, please scan the above QR code or manually navigate to the following URL in your mobile browser:
sy-b-translation-37
Additional instruction when the component is in mobile capture mode
The flow will continue after running selfie capture and clicking the "Complete Step" button on your mobile device
sy-b-translation-38
Caption of the button that cancels mobile capture
Cancel
sy-b-translation-39
Caption of the button that copies the mobile link to clipboard
Copy Link
sy-b-translation-40
Caption of the button that starts mobile capture mode
Mobile Capture
sy-b-translation-41
Caption of the button that proceeds to the liveness page
Take Selfie
sy-b-translation-42
Text to temporarily change the copy button caption to once a link is copied
Copied!
sy-b-translation-43
Text to temporarily change the copy button caption to once a link fails to copy
Failed to copy...