onfido-sdk-ui

import { FaceTecVocalGuidanceMode } from "./FaceTecPublicApi"; export declare enum FaceTecExitAnimationStyle { None = 0, RippleOut = 1, FadeOutMin = 2 } export declare enum FaceTecCancelButtonLocation { Disabled = 0, TopLeft = 1, TopRight = 2, Custom = 3 } export declare enum FaceTecSecurityWatermarkImage { FaceTec_ZoOm = 0, FaceTec = 1 } export declare class FaceTecRect { x: number; y: number; width: number; height: number; constructor(); create(x: number, y: number, width: number, height: number): this; } export interface FaceTecFeedbackBarCustomization { shadow: string; backgroundColor: string; cornerRadius: string; textFont: string; textColor: string; enablePulsatingText: boolean; } export interface FaceTecInitialLoadingAnimationCustomization { customAnimation: SVGElement | null; animationRelativeScale: number; backgroundColor: string; foregroundColor: string; messageTextColor: string; messageFont: string; } export interface FaceTecFrameCustomization { shadow: string; backgroundColor: string; borderColor: string; borderWidth: string; borderCornerRadius: string; } export interface FaceTecCancelButtonCustomization { customImage: string; location: FaceTecCancelButtonLocation; customLocation: FaceTecRect; } export interface FaceTecExitAnimationCustomization { exitAnimationSuccess: FaceTecExitAnimationStyle; exitAnimationUnsuccess: FaceTecExitAnimationStyle; } export interface FaceTecSessionTimerCustomization { livenessCheckNoInteractionTimeout: number; idScanNoInteractionTimeout: number; } export interface FaceTecGuidanceCustomization { buttonFont: string; buttonBorderWidth: string; buttonBorderColor: string; buttonCornerRadius: string; buttonTextNormalColor: string; buttonTextHighlightColor: string; buttonTextDisabledColor: string; buttonBackgroundNormalColor: string; buttonBackgroundHighlightColor: string; buttonBackgroundDisabledColor: string; headerFont: string; subtextFont: string; readyScreenHeaderFont: string; readyScreenHeaderTextColor: string; readyScreenHeaderAttributedString: string; readyScreenSubtextFont: string; readyScreenSubtextTextColor: string; readyScreenSubtextAttributedString: string; retryScreenHeaderFont: string; retryScreenHeaderTextColor: string; retryScreenHeaderAttributedString: string; retryScreenSubtextFont: string; retryScreenSubtextTextColor: string; retryScreenSubtextAttributedString: string; backgroundColors: string; foregroundColor: string; readyScreenOvalFillColor: string; readyScreenTextBackgroundColor: string; readyScreenTextBackgroundCornerRadius: string; retryScreenIdealImage: string; retryScreenSlideshowImages: string[]; retryScreenSlideshowInterval: string; enableRetryScreenSlideshowShuffle: boolean; retryScreenImageBorderColor: string; retryScreenImageBorderWidth: string; retryScreenImageCornerRadius: string; retryScreenOvalStrokeColor: string; cameraPermissionsScreenImage: string; } export interface FaceTecEnterFullScreenCustomization { buttonFont: string; buttonBorderWidth: string; buttonBorderColor: string; buttonCornerRadius: string; buttonTextNormalColor: string; buttonTextHighlightColor: string; buttonTextDisabledColor: string; buttonBackgroundNormalColor: string; buttonBackgroundHighlightColor: string; buttonBackgroundDisabledColor: string; buttonRelativeWidth: string; buttonRelativeWidthOnDesktop: string; headerFont: string; subtextFont: string; backgroundColors: string; foregroundColor: string; enterFullScreenImage: string; } export interface FaceTecOverlayCustomization { backgroundColor: string; showBrandingImage: boolean; brandingImage: string; } export interface FaceTecResultScreenCustomization { backgroundColors: string; foregroundColor: string; resultAnimationBackgroundColor: string; resultAnimationForegroundColor: string; resultAnimationSuccessBackgroundImage: string; resultAnimationUnsuccessBackgroundImage: string; customResultAnimationSuccess: SVGElement | null; customResultAnimationUnsuccess: SVGElement | null; messageFont: string; activityIndicatorColor: string; customActivityIndicatorImage: string; customActivityIndicatorRotationInterval: string; customActivityIndicatorAnimation: SVGElement | null; animationRelativeScale: number; showUploadProgressBar: boolean; uploadProgressFillColor: string; uploadProgressTrackColor: string; } export interface FaceTecOvalCustomization { /** * Color of the the FaceTec Browser SDK Oval outline. * Default is white. */ strokeColor: string; /** * Color of the animated FaceTec Browser SDK Progress Spinner strokes. * Default is custom FaceTec Browser SDK color. */ progressColor1: string; progressColor2: string; /** * Thickness of the animated FaceTec Browser SDK Progress Spinner strokes. * Default is dynamically configured per device at runtime. */ progressStrokeWidth: number; /** * Thickness of the FaceTec Browser SDK Oval outline. * Default is dynamically configured per device at runtime. */ strokeWidth: number; } export interface FaceTecIDScanCustomization { /** * Controls whether to show the 'FaceTec_branding_logo_id_check' image (or image configured with .selectionScreenBrandingImage) on the Identity Document Type Selection Screen. * Default is false (hidden). */ showSelectionScreenBrandingImage: boolean; /** * Controls whether to show the 'FaceTec_document' image (or image configured with .selectionScreenDocumentImage) on the Identity Document Type Selection Screen. * Default is true (visible). */ showSelectionScreenDocumentImage: boolean; /** * Color of the text displayed on the Identity Document Type Selection Screen (not including the action button text). * Default is off-black. */ selectionScreenForegroundColor: string; /** * Font of the title during the Identity Document Type Selection Screen. * Accepts any value assignable to the fontFamily CSS attribute. */ headerFont: string; /** * Font of the message text during the Identity Document Capture and Review Screens. * Accepts any value assignable to the fontFamily CSS attribute. */ subtextFont: string; /** * Font of the action button's text during the Photo ID Match Screens. * Accepts any value assignable to the fontFamily CSS attribute. */ buttonFont: string; /** * Thickness of the action button's border during the Photo ID Match Screens. * Default is dynamically configured per device at runtime. */ buttonBorderWidth: string; /** * Color of the action button's border during the Photo ID Match Screens. * Default is transparent. */ buttonBorderColor: string; /** * Corner radius of the action button's border during the Photo ID Match Screens. * Default is dynamically configured per device at runtime. */ buttonCornerRadius: string; /** * Color of the action button's text during the Photo ID Match Screens. * Default is white. */ buttonTextNormalColor: string; /** * Color of the action button's text when the button is pressed during the Photo ID Match Screens. * Default is white. */ buttonTextHighlightColor: string; /** * Color of the action button's text when the button is disabled during the Photo ID Match Screens. * Default is white. */ buttonTextDisabledColor: string; /** * Color of the action button's background during the Photo ID Match Screens. * Default is custom FaceTec Browser SDK color. */ buttonBackgroundNormalColor: string; /** * Color of the action button's background when the button is pressed during the Photo ID Match Screens. * Default is custom FaceTec Browser SDK color. */ buttonBackgroundHighlightColor: string; /** * Color of the action button's background when the button is disabled during the Photo ID Match Screens. * Default is custom FaceTec Browser SDK color. */ buttonBackgroundDisabledColor: string; /** * Color of the Identity Document Type Selection Screen background. * Default is white. */ selectionScreenBackgroundColors: string; /** * Image displayed along the top of the Identity Document Type Selection Screen. * Default is configured to use image named 'FaceTec_branding_logo_id_check' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ selectionScreenBrandingImage: string; /** * Image displayed in the middle of the Identity Document Type Selection Screen. * Default is configured to use image named 'FaceTec_document' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ selectionScreenDocumentImage: string; /** * Color of the text displayed on the Identity Document Capture Screen (not including the action button text). * Default is white. */ captureScreenForegroundColor: string; /** * Color of the text view background during the Identity Document Capture Screen. * Default is custom FaceTec Browser SDK color. */ captureScreenTextBackgroundColor: string; /** * Color of the text view background border during the Identity Document Capture Screen. * Default is transparent. */ captureScreenTextBackgroundBorderColor: string; /** * Thickness of the text view background border during the Identity Document Capture Screen. * Default is 0. */ captureScreenTextBackgroundBorderWidth: string; /** * Corner radius of the text view background and border during the Identity Document Capture Screen. * Default is dynamically configured per device at runtime. */ captureScreenTextBackgroundCornerRadius: string; /** * Color of the Identity Document Capture Screen's background. * Default is white. */ captureScreenBackgroundColor: string; /** * Color of the Identity Document Capture Frame's stroke. * Default is custom FaceTec Browser SDK color. */ captureFrameStrokeColor: string; /** * Thickness of the Identity Document Capture Frame's stroke. * Default is dynamically configured per device at runtime. */ captureFrameStrokeWidth: string; /** * Corner radius of the Identity Document Capture Frame. * Default is dynamically configured per device at runtime. */ captureFrameCornerRadius: string; /** * Color of the text displayed on the Identity Document Review Screen (not including the action button text). * Default is white. */ reviewScreenForegroundColor: string; /** * Color of the text view background during the Identity Document Review Screen. * Default is custom FaceTec Browser SDK color. */ reviewScreenTextBackgroundColor: string; /** * Color of the text view background border during the Identity Document Review Screen. * Default is transparent. */ reviewScreenTextBackgroundBorderColor: string; /** * Thickness of the text view background border during the Identity Document Review Screen. * Default is 0. */ reviewScreenTextBackgroundBorderWidth: string; /** * Corner radius of the text view background and border during the Identity Document Review Screen. * Default is dynamically configured per device at runtime. */ reviewScreenTextBackgroundBorderCornerRadius: string; /** * Corner radius of the ID Document Preview image displayed on the Identity Document Review Screen. * Default is dynamically configured per device at runtime. */ reviewScreenDocumentPreviewCornerRadius: string; /** * Color of the Identity Document Review Screen background. * Default is white. */ reviewScreenBackgroundColors: string; /** * Image displayed below the FaceTec Browser SDK Frame during Photo ID Match when the Identity Document Type selected is an ID Card. * This image acts as a placeholder to show a status of incomplete for capturing the ID Card's front side. * This only applies to desktop browsers. * Default is configured to use image named 'FaceTec_id_card_placeholder_front' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ captureScreenIDFrontPlaceHolderImage: string; /** * Image displayed below the FaceTec Browser SDK Frame during Photo ID Match when the Identity Document Type selected is an ID Card. * This image acts as a placeholder to show a status of incomplete for capturing the ID Card's back side. * This only applies to desktop browsers. * Default is configured to use image named 'FaceTec_id_card_placeholder_back' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ captureScreenIDBackPlaceHolderImage: string; /** * Image displayed below the FaceTec Browser SDK Frame during Photo ID Match when the Identity Document Type selected is a Passport. * This image acts as a placeholder to show a status of incomplete for capturing the Passport. * This only applies to desktop browsers. * Default is configured to use image named 'FaceTec_passport_placeholder' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ captureScreenPassportPlaceholderImage: string; /** * Image displayed below the FaceTec Browser SDK Frame during Photo ID Match when the Identity Document Type selected is an ID Card. * This image acts as a placeholder to show a status of complete for capturing the ID Card's front side. * This only applies to desktop browsers. * Default is configured to use image named 'FaceTec_id_front_checkmark' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ captureScreenIDFrontCheckmarkImage: string; /** * Image displayed below the FaceTec Browser SDK Frame during Photo ID Match when the Identity Document Type selected is an ID Card. * This image acts as a placeholder to show a status of complete for capturing the ID Card's back side. * This only applies to desktop browsers. * Default is configured to use image named 'FaceTec_id_back_checkmark' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ captureScreenIDBackCheckmarkImage: string; /** * Image displayed below the FaceTec Browser SDK Frame during Photo ID Match when the Identity Document Type selected is a Passport. * This image acts as a placeholder to show a status of complete for capturing the Passport. * This only applies to desktop browsers. * Default is configured to use image named 'FaceTec_passport_checkmark' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ captureScreenPassportCheckmarkImage: string; } export interface FaceTecOCRConfirmationCustomization { backgroundColors: string; mainHeaderDividerLineColor: string; mainHeaderDividerLineWidth: string; mainHeaderFont: string; mainHeaderTextColor: string; sectionHeaderFont: string; sectionHeaderTextColor: string; fieldLabelFont: string; fieldLabelTextColor: string; fieldValueFont: string; fieldValueTextColor: string; inputFieldBackgroundColor: string; inputFieldFont: string; inputFieldTextColor: string; inputFieldBorderColor: string; inputFieldBorderWidth: string; inputFieldCornerRadius: string; inputFieldPlaceholderFont: string; inputFieldPlaceholderTextColor: string; showInputFieldBottomBorderOnly: boolean; buttonFont: string; buttonBorderWidth: string; buttonBorderColor: string; buttonCornerRadius: string; buttonTextNormalColor: string; buttonTextHighlightColor: string; buttonTextDisabledColor: string; buttonBackgroundNormalColor: string; buttonBackgroundHighlightColor: string; buttonBackgroundDisabledColor: string; } export interface FaceTecSecurityWatermarkCustomization { securityWatermarkImage: FaceTecSecurityWatermarkImage; } /** * Class used to customize the look and feel of the FaceTec Browser SDK Interface. * FaceTec Browser SDK ships with a default FaceTec Browser SDK theme but has a variety of variables that you can use to configure the FaceTec Browser SDK to your application's needs. * To customize the FaceTec Browser SDK Interface, simply create an instance of FaceTecCustomization and set some, or all, of the variables. */ export declare class FaceTecCustomization { /** Customize the FaceTec Browser SDK Oval and the FaceTec Browser SDK Progress Spinner animations. */ ovalCustomization: FaceTecOvalCustomization; /** Customize the FaceTec Browser SDK Feedback Bar. */ feedbackCustomization: FaceTecFeedbackBarCustomization; /** Customize the FaceTec Browser SDK Frame. */ frameCustomization: FaceTecFrameCustomization; /** Customize the FaceTec Browser SDK Frame exit animation. */ exitAnimationCustomization: FaceTecExitAnimationCustomization; /** Customize the FaceTec Browser SDK Cancel Button. */ cancelButtonCustomization: FaceTecCancelButtonCustomization; /** DEPRECATED - Customize the time after which the FaceTec Browser SDK Session should timeout. */ sessionTimerCustomization: FaceTecSessionTimerCustomization; /** Customize the loading spinner and the text shown to the user while the camera loads. */ initialLoadingAnimationCustomization: FaceTecInitialLoadingAnimationCustomization; /** Customize the New User Guidance and Retry Screens. */ guidanceCustomization: FaceTecGuidanceCustomization; /** Customize the FaceTec Browser SDK Overlay, separating the FaceTec Browser SDK Interface from the presenting application context. */ overlayCustomization: FaceTecOverlayCustomization; /** Customize the Result Screen. */ resultScreenCustomization: FaceTecResultScreenCustomization; /** Customize the FaceTec Browser SDK Photo ID Match Screens. */ idScanCustomization: FaceTecIDScanCustomization; /** Customize the FaceTec Browser SDK User OCR Confirmation Screen. */ ocrConfirmationCustomization: FaceTecOCRConfirmationCustomization; /** Customize the FaceTec Browser SDK IFrame Enter Full Screen User Interface. * This customization is only active when the FaceTec Browser SDK is loaded in an IFrame. * Permission from FaceTec is required to run the FaceTec Browser SDK in an iFrame. * Please contact FaceTec to request access. */ enterFullScreenCustomization: FaceTecEnterFullScreenCustomization; /** Customize the FaceTec Security Watermark Image by selecting from 1 of the 3 available FaceTec watermarks. */ securityWatermarkCustomization: FaceTecSecurityWatermarkCustomization; /** Customize the FaceTec Vocal Guidance audio files. */ vocalGuidanceCustomization: FaceTecVocalGuidanceCustomization; /** Allow FaceTec Browser SDK to cancel due to context switch when unauthorized key strokes are detected while the FaceTec Browser SDK is active. For accessibility, essential navigation hotkeys will not trigger cancellation. */ enableHotKeyProtection: boolean; /** Show Camera Permissions Denied Screen. */ enableCameraPermissionsHelpScreen: boolean; /** Force the oval stroke to be drawn as opaque. */ shouldDrawOvalStrokeOpaque: boolean; /** Control whether to enable clickable Ready Screen subtext region, cancelling from the session and returning FaceTecSessionStatus.UserCancelledViaClickableReadyScreenSubtext. */ enableClickableReadyScreenSubtext: boolean; /** For non-production instances, display the clickable Development Mode Tag link during the Result Screen. */ enableDevelopmentModeTag: boolean; /** * Control whether strings on the Ready Screen and Retry Screen are limited to a max character count. * Note: This functionality is not available by default, and must be requested from FaceTec in order to enable. * Default is false (disabled). */ enableUnconstrainedGuidanceStringLengths: boolean; /** * This function allows special runtime control of the success message shown when the success animation occurs for a FaceScan. * Please note that you can also customize this string via the standard customization/localization methods provided by the FaceTec Browser SDK. * Special runtime access is enabled to this text because the developer may wish to change this text depending on the FaceTec Browser SDK's mode of operation. * This method does not update the success message for an ID Scan. For runtime control over the result messages displayed for an ID Scan, use the method setIDScanResultScreenMessageOverrides. * Default is in the customizable localization string "FaceTec_result_success_message". */ static setOverrideResultScreenSuccessMessage: (message: string) => void; /** * This function allows special runtime control of the various possible result messages shown when the result animation occurs for an ID Scan Session.<br> * Please note that you can also customize these strings via the standard customization/localization methods provided.<br> */ static setIDScanResultScreenMessageOverrides: (successFrontSide: string, successFrontSideBackNext: string, successBackSide: string, successUserConfirmation: string, retryFaceDidNotMatch: string, retryIDNotFullyVisible: string, retryOCRResultsNotGoodEnough: string, retryIDTypeNotSupported?: string) => void; /** * This function allows special runtime control of the various possible upload messages shown when the Result Screen's upload progress content is shown for an ID Scan Session. * If this method is used, any values configured with FaceTecIDScanResultCallback.uploadMessageOverride will be overridden with the applicable value configured with this method. * Please note that for proper behavior of these dynamic upload message values, it is required that there is appropriate use of FaceTecIDScanResultCallback.uploadProgress to track the progress of the request body being uploaded to the Sever. */ static setIDScanUploadMessageOverrides: (frontSideUploadStarted: string, frontSideStillUploading: string, frontSideUploadCompleteAwaitingResponse: string, frontSideUploadCompleteAwaitingProcessing: string, backSideUploadStarted: string, backSideStillUploading: string, backSideUploadCompleteAwaitingResponse: string, backSideUploadCompleteAwaitingProcessing: string, userConfirmedInfoUploadStarted: string, userConfirmedInfoStillUploading: string, userConfirmedInfoUploadCompleteAwaitingResponse: string, userConfirmedInfoUploadCompleteAwaitingProcessing: string) => void; /** * Constructor for FaceTecCustomization object. * * @param keyValuePairs - The FaceTec Browser SDK Feature Flag key-value pairs for restricted customization access. */ constructor(keyValuePairs?: { key: string; }[] | any[]); [key: string]: { key: string; }[] | boolean | FaceTecVocalGuidanceCustomization | FaceTecSecurityWatermarkCustomization | FaceTecEnterFullScreenCustomization | FaceTecOCRConfirmationCustomization | FaceTecIDScanCustomization | FaceTecOvalCustomization | FaceTecFeedbackBarCustomization | FaceTecFrameCustomization | FaceTecExitAnimationCustomization | FaceTecCancelButtonCustomization | FaceTecSessionTimerCustomization | FaceTecInitialLoadingAnimationCustomization | FaceTecGuidanceCustomization | FaceTecOverlayCustomization | FaceTecResultScreenCustomization | string; } /** * DEPRECATED */ export declare class FaceTecSessionTimerCustomization { /** * DEPRECATED */ maxTimeBeforeCameraPermissionsError: number; /** * DEPRECATED */ livenessCheckNoInteractionTimeout: number; /** * DEPRECATED */ idScanNoInteractionTimeout: number; /** Constructor for FaceTecSessionTimerCustomization object. */ constructor(); } /** * Customize the FaceTec Session Frame exit animation. */ export declare class FaceTecExitAnimationCustomization { /** Customize the transition out animation for a successful FaceTec Browser SDK Session. */ exitAnimationSuccess: FaceTecExitAnimationStyle; /** Customize the transition out animation for an unsuccessful FaceTec Browser SDK Session. */ exitAnimationUnsuccess: FaceTecExitAnimationStyle; /** Constructor for FaceTecExitAnimationCustomization object. */ constructor(); } /** * Customize the FaceTec Session Oval and the FaceTec Session Progress Spinner animations. */ export declare class FaceTecOvalCustomization { /** * Color of the the FaceTec Browser SDK Oval outline. * Default is white. */ strokeColor: string; /** * Color of the animated FaceTec Browser SDK Progress Spinner strokes. * Default is custom FaceTec Browser SDK color. */ progressColor1: string; progressColor2: string; /** * Thickness of the animated FaceTec Browser SDK Progress Spinner strokes. * Default is dynamically configured per device at runtime. */ progressStrokeWidth: number; /** * Thickness of the FaceTec Browser SDK Oval outline. * Default is dynamically configured per device at runtime. */ strokeWidth: number; /** Constructor for FaceTecOvalCustomization object. */ constructor(); } /** * Customize the FaceTec Session Frame. */ export declare class FaceTecFrameCustomization { /** * Shadow displayed behind the FaceTec Browser SDK Frame. * This accepts box-shadow css attribute string values. * Default is none. */ shadow: string; /** * Color of the FaceTec Browser SDK Frame's border. * Default is white. */ borderColor: string; /** * Corner radius of the FaceTec Browser SDK Frame. * Default is dynamically configured per device at runtime. */ borderCornerRadius: string; /** * Thickness of the FaceTec Browser SDK Frame's border. * Default is dynamically configured per device at runtime. */ borderWidth: string; /** * Color of the background surrounding the oval outline during FaceTec Browser SDK session. * Default is custom FaceTec Browser SDK color. */ backgroundColor: string; /** Constructor for FaceTecFrameCustomization object. */ constructor(); } /** * Customize the FaceTec Browser SDK Cancel Button. * Shown during FaceTec Browser SDK session, New User Guidance, Retry, and Photo ID Match Screens. */ export declare class FaceTecCancelButtonCustomization { /** * Location, or use, of the FaceTec Browser SDK Cancel Button. * Default is FaceTecCancelButtonLocation.TopLeft. */ location: FaceTecCancelButtonLocation; /** * The size and location of the cancel button within the current screen's bounds. * Configure using the convenience method .setCustomLocation(x:number, y:number, width:number, height:number). * Note: In order to use a custom-located cancel button, you MUST set .location to the enum value FaceTecCancelButtonLocation.Custom. * Default is set at origin 0,0 with a size of 0 by 0. */ customLocation: FaceTecRect; /** * Image displayed on the FaceTec Browser SDK Cancel Button. * Default is configured to use image named 'FaceTec_cancel' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ customImage: string; /** Constructor for FaceTecCancelButtonCustomization object. */ constructor(); /** * Set the size and location of the cancel button within the current screen's bounds. * Note: In order to use a custom-located cancel button, you MUST set .location to the enum value FaceTecCancelButtonLocation.Custom. */ setCustomLocation(x: number, y: number, width: number, height: number): void; } /** * Customize the FaceTec Session Feedback Bar. */ export declare class FaceTecFeedbackBarCustomization { /** * Color of the FaceTec Browser SDK Feedback Bar's background. Recommend making this have some transparency. * Default is custom FaceTec Browser SDK color. */ backgroundColor: string; /** * Color of the text displayed within the FaceTec Browser SDK Feedback Bar. * Default is white. */ textColor: string; /** * Font of the text displayed within the FaceTec Browser SDK Feedback Bar. * Accepts any value assignable to the fontFamily CSS attribute. */ textFont: string; /** * Corner radius of the FaceTec Browser SDK Feedback Bar. * Default is dynamically configured per device at runtime. */ cornerRadius: string; /** * Shadow displayed behind the FaceTec Browser SDK Feedback Bar. * This accepts box-shadow css attribute string values. * Default is a custom sized black shadow. */ shadow: string; /** * Control whether to enable the pulsating text animation within the FaceTec Browser SDK Feedback Bar. * Default is true (enabled). */ enablePulsatingText: boolean; /** Constructor for FaceTecFeedbackBarCustomization object. */ constructor(); } /** * Customize the loading spinner and the text shown to the user while the camera loads. */ export declare class FaceTecInitialLoadingAnimationCustomization { /** * Control the size of the animation displayed while the camera is loading. * This value represents the scaling factor that will be applied to the default animation bounds. * This value has to be between 0.5 and 2.0. If it’s lower than 0.5 or higher than 2.0, it will be defaulted to 0.5 or 2.0 respectively. * Default value is 1. */ animationRelativeScale: number; /** * Configure an SVG element to display while the camera is loading. * Note: All CSS required for the SVG animation needs to be included in your app's CSS file before launching FaceTec Browser SDK. * Note: The activity indicator animation is displayed indefinitely while the camera loads, so the custom animation should be set to loop/repeat infinitely. * If this is set to an SVGElement object, the SVG supplied will be used instead of the default loading spinner animation. * If this is null, default loading spinner will be used. * Default is null. */ customAnimation: SVGElement | null; /** * Color of the loading spinner background track shown to the user while the camera loads. * Default is off-white. */ backgroundColor: string; /** * Color of the loading spinner foreground fill and message text shown to the user while the camera loads. * If this value is an empty string, FaceTecOverlayCustomization.foregroundColor will be used for the color of the loading spinner foreground fill and message text. * Default is custom FaceTec Browser SDK color. */ foregroundColor: string; /** * Color of the message text shown to the user while the camera loads. * Note: This will override the text color configured with FaceTecOverlayCustomization.foregroundColor or FaceTecInitialLoadingAnimationCustomization.foregroundColor. * If this value is an empty string, FaceTecInitialLoadingAnimationCustomization.foregroundColor will be used for the color of the message text. * Default is an empty string. */ messageTextColor: string; /** * Font of the message text shown to the user while the camera loads. * Accepts any value assignable to the fontFamily CSS attribute. */ messageFont: string; /** Constructor for FaceTecInitialLoadingAnimationCustomization object. */ constructor(); } /** * Customize the New User Guidance and Retry Screens. * New User Guidance Screens are shown before the FaceTec Browser SDK Session and Retry Screens are shown after an unsuccessful FaceTec Browser SDK Session. */ export declare class FaceTecGuidanceCustomization { private defaultLocationForImages; /** * Thickness of the action button's border during the New User Guidance and Retry Screens. * Default is dynamically configured per device at runtime. */ buttonBorderWidth: string; /** * Color of the action button's border during the New User Guidance and Retry Screens. * Default is transparent. */ buttonBorderColor: string; /** * Corner radius of the action button's border during the New User Guidance and Retry Screens. * Default is dynamically configured per device at runtime. */ buttonCornerRadius: string; /** * Color of the action button's text during the New User Guidance and Retry Screens. * Default is white. */ buttonTextNormalColor: string; /** * Color of the action button's text when the button is pressed during the New User Guidance and Retry Screens. * Default is white. */ buttonTextHighlightColor: string; /** * Color of the action button's text when the button is disabled during the New User Guidance and Retry Screens. * Default is white. */ buttonTextDisabledColor: string; /** * Color of the action button's background during the New User Guidance and Retry Screens. * Default is custom FaceTec Browser SDK color. */ buttonBackgroundNormalColor: string; /** * Color of the action button's background when the button is pressed during the New User Guidance and Retry Screens. * Default is custom FaceTec Browser SDK color. */ buttonBackgroundHighlightColor: string; /** * Color of the action button's background when the button is disabled during the New User Guidance and Retry Screens. * Default is custom FaceTec Browser SDK color. */ buttonBackgroundDisabledColor: string; /** * Font of the title's text during the New User Guidance and Retry Screens. * Note: This customization can be overridden for specific text using FaceTecGuidanceCustomization.readyScreenHeaderFont and/or .retryScreenHeaderFont. * Accepts any value assignable to the fontFamily CSS attribute. */ headerFont: string; /** * Font of the title's subtext and messages during the New User Guidance and Retry Screens. * Note: This customization can be overridden for specific text using FaceTecGuidanceCustomization.readyScreenSubtextFont and/or .retryScreenSubtextFont. * Accepts any value assignable to the fontFamily CSS attribute. */ subtextFont: string; /** * Font of the title's text displayed on the Get Ready To FaceTec Browser SDK Screen during the New User Guidance and Retry Screens. * Note: This will override the header font configured with FaceTecGuidanceCustomization.headerFont for the Get Ready To FaceTec Browser SDK Screen. * Accepts any value assignable to the fontFamily CSS attribute. * If this value is an empty string, FaceTecGuidanceCustomization.headerFont will be used for the font of the title's text displayed on the Get Ready To FaceTec Browser SDK Screen. * Default value is an empty string. */ readyScreenHeaderFont: string; /** * Color of the header text displayed on the Get Ready To FaceTec Browser SDK Screen during the New User Guidance and Retry Screens. * Note: This will override the header text color configured with FaceTecGuidanceCustomization.foregroundColor for the Get Ready To FaceTec Browser SDK Screen. * If this value is an empty string, FaceTecGuidanceCustomization.foregroundColor will be used for the color of the title's text displayed on the Get Ready To FaceTec Browser SDK Screen. * Default value is an empty string. */ readyScreenHeaderTextColor: string; /** * Specify an html-attributed string to use instead of the localized string for the text of the title displayed on the Get Ready To FaceTec Browser SDK Screen during the New User Guidance and Retry Screens. * If this value is an empty string, the localized string, FaceTec_instructions_header_ready, will be used for the text of the title displayed on the Get Ready To FaceTec Browser SDK Screen during the New User Guidance and Retry Screens. * Default is an empty string. */ readyScreenHeaderAttributedString: string; /** * Font of the title's subtext displayed on the Get Ready for Video Selfie Screen during the New User Guidance and Retry Screens. * Note: This will override the title's subtext font configured with FaceTecGuidanceCustomization.subtextFont for the Get Ready for Video Selfie Screen. * Accepts any value assignable to the fontFamily CSS attribute. * If this value is an empty string, FaceTecGuidanceCustomization.subtextFont will be used for the font of the title's subtext displayed on the Get Ready for Video Selfie Screen. * Default value is an empty string. */ readyScreenSubtextFont: string; /** * Color of the title's subtext displayed on the Get Ready for Video Selfie Screen during the New User Guidance and Retry Screens. * Note: This will override the title's subtext color configured with FaceTecGuidanceCustomization.foregroundColor for the Get Ready for Video Selfie Screen. * If this value is an empty string, FaceTecGuidanceCustomization.foregroundColor will be used for the color of the title's subtext displayed on the Get Ready for Video Selfie Screen. * Default value is an empty string. */ readyScreenSubtextTextColor: string; /** * Specify an html-attributed string to use instead of the localized string for the text of the title's subtext displayed on the Get Ready for Video Selfie Screen during the New User Guidance and Retry Screens. * If this value is an empty string, the localized string, FaceTec_instructions_message_ready, will be used for the text of the title's subtext displayed on the Get Ready for Video Selfie Screen during the New User Guidance and Retry Screens. * Default is an empty string. */ readyScreenSubtextAttributedString: string; /** * Font of the title's text displayed on the first Retry Screen. * Note: This will override the header font configured with FaceTecGuidanceCustomization.headerFont for the first Retry Screen. * Accepts any value assignable to the fontFamily CSS attribute. * If this value is an empty string, FaceTecGuidanceCustomization.headerFont will be used for the font of the title's text displayed on the first Retry Screen. * Default value is an empty string. */ retryScreenHeaderFont: string; /** * Color of the header text displayed on the first Retry Screen. * Note: This will override the header text color configured with FaceTecGuidanceCustomization.foregroundColor for the first Retry Screen. * If this value is an empty string, FaceTecGuidanceCustomization.foregroundColor will be used for the color of the title's text displayed on the first Retry Screen. * Default value is an empty string. */ retryScreenHeaderTextColor: string; /** * Specify an html-attributed string to use instead of the localized string for the text of the title displayed on the first Retry Screen. * If this value is an empty string, the localized string, FaceTec_retry_header, will be used for the text of the title displayed on the first Retry Screen. * Default is an empty string. */ retryScreenHeaderAttributedString: string; /** * Font of the title's subtext and messages displayed on the first Retry Screen. * Note: This will override the font of the title's subtext and messages configured with FaceTecGuidanceCustomization.subtextFont for the first Retry Screen. * Accepts any value assignable to the fontFamily CSS attribute. * If this value is an empty string, FaceTecGuidanceCustomization.subtextFont will be used for the font of the title's subtext and messages displayed on the first Retry Screen. * Default value is an empty string. */ retryScreenSubtextFont: string; /** * Color of the title's subtext and messages displayed on the first Retry Screen. * Note: This will override the title's subtext and message color configured with FaceTecGuidanceCustomization.foregroundColor for the first Retry Screen. * If this value is an empty string, FaceTecGuidanceCustomization.foregroundColor will be used for the color of the title's subtext displayed on the first Retry Screen. * Default value is an empty string. */ retryScreenSubtextTextColor: string; /** * Specify an html-attributed string to use instead of the localized string for the text of the title's subtext displayed on the first Retry Screen. * If this value is an empty string, the localized strings, FaceTec_retry_subheader_message, will be used for the text of the title's subtext displayed on the first Retry Screen. * Default is an empty string. */ retryScreenSubtextAttributedString: string; /** * Font of the action button's text during the New User Guidance and Retry Screens. * Accepts any value assignable to the fontFamily CSS attribute. * Default is a bold system font. */ buttonFont: string; /** * Color of the background for the New User Guidance and Retry Screens. * Default is white. */ backgroundColors: string; /** * Color of the text displayed on the New User Guidance and Retry Screens (not including the action button text). * Note: This customization can be overridden for specific text using FaceTecGuidanceCustomization.readyScreenHeaderTextColor, .readyScreenSubtextTextColor, .retryScreenHeaderTextColor, and/or .retryScreenSubtextTextColor. * Default is custom FaceTec Browser SDK color. */ foregroundColor: string; /** * Color of the Get Ready for Video Selfie Screen's oval fill. * Default is transparent. */ readyScreenOvalFillColor: string; /** * Background color of the Get Ready for Video Selfie Screen text views during the New User Guidance and Retry Screens. * This will only be visible when text is detected as overlapping or too close with the Ready screen oval. * Default is white. */ readyScreenTextBackgroundColor: string; /** * Background corner radius of the Get Ready for Video Selfie Screen text views during the New User Guidance and Retry Screens. * This will only be visible when text is detected as overlapping or too close with the Get Ready for Video Selfie Screen's oval. * Default is dynamically configured per device at runtime. */ readyScreenTextBackgroundCornerRadius: string; /** * Image displayed as Ideal FaceTec Browser SDK example (right image) during the first Retry Screen. * Default is configured to use image named 'FaceTec_ideal' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ retryScreenIdealImage: string; /** * Images displayed as Ideal FaceTec Browser SDK examples (right image) during the first Retry Screen. * When configured to a non-empty array, these images will override the single image configured for FaceTecGuidanceCustomization.retryScreenIdealImage. * Default is an empty array. */ retryScreenSlideshowImages: string[]; /** * Control the time that each image is shown for before transitioning to the next image. * Default is 1500ms. */ retryScreenSlideshowInterval: string; /** * Control whether to allow the slideshow images to appear in a randomized order during each Retry Screen. * Default is true (enabled). */ enableRetryScreenSlideshowShuffle: boolean; /** * Color of the image borders during the first Retry Screen. * Default is custom FaceTec Browser SDK color. */ retryScreenImageBorderColor: string; /** * Thickness of the image borders during the first Retry Screen. * Default is dynamically configured per device at runtime. */ retryScreenImageBorderWidth: string; /** * Corner radius of the image borders during the first Retry Screen. * Default is dynamically configured per device at runtime. */ retryScreenImageCornerRadius: string; /** * Color of the oval's stroke that overlay's the Ideal image example during the first Retry Screen. * Default is white. */ retryScreenOvalStrokeColor: string; /** * Image displayed on the Camera Permissions Screen. * Default is configured to use image named 'FaceTec_camera' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ cameraPermissionsScreenImage: string; /** * Constructor for FaceTecGuidanceCustomization object. * * @param directoryForImageFiles - (optional) specify a custom directory to search for default image path names. */ constructor(directoryForImageFiles?: string); } /** * Customize the New User Guidance and Retry Screens. * New User Guidance Screens are shown before the FaceTec Browser SDK Session and Retry Screens are shown after an unsuccessful FaceTec Browser SDK Session. */ export declare class FaceTecEnterFullScreenCustomization { private defaultLocationForImages; /** * Thickness of the action button's border during the Enter Full Screen Page. * Default is dynamically configured per device at runtime. */ buttonBorderWidth: string; /** * Color of the action button's border during the Enter Full Screen Page. * Default is transparent. */ buttonBorderColor: string; /** * Corner radius of the action button's border during the Enter Full Screen Page. * Default is dynamically configured per device at runtime. */ buttonCornerRadius: string; /** * Color of the action button's text during the Enter Full Screen Page. * Default is white. */ buttonTextNormalColor: string; /** * Color of the action button's text when the button is pressed during the Enter Full Screen Page. * Default is white. */ buttonTextHighlightColor: string; /** * Color of the action button's text when the button is disabled during the Enter Full Screen Page. * Default is white. */ buttonTextDisabledColor: string; /** * Color of the action button's background during the Enter Full Screen Page. * Default is custom FaceTec Browser SDK color. */ buttonBackgroundNormalColor: string; /** * Color of the action button's background when the button is pressed during the Enter Full Screen Page. * Default is custom FaceTec Browser SDK color. */ buttonBackgroundHighlightColor: string; /** * Color of the action button's background when the button is disabled during the Enter Full Screen Page. * Default is custom FaceTec Browser SDK color. */ buttonBackgroundDisabledColor: string; /** * Font of the title's text during the Enter Full Screen Page. */ headerFont: string; /** * Font of the title's subtext and messages during the Enter Full Screen Page. */ subtextFont: string; /** * Font of the title's subtext during the Enter Full Screen Page. * Default is a bold system font. */ buttonFont: string; /** * Color of the background for the Enter Full Screen Page. * Default is white. */ backgroundColors: string; /** * Color of the text displayed on the Enter Full Screen Page (not including the action button text). * Default is custom FaceTec Browser SDK color. */ foregroundColor: string; /** * Image displayed on the Enter Full Screen Page. * Default is configured to use image named 'FaceTec_enter_fullscreen' located in '/FaceTec_images/' directory (or custom configured default directory for FaceTec Browser SDK images). */ enterFullScreenImage: string; /** * Shadow displayed behind the Enter Full Screen Page. * This accepts box-shadow css attribute string values. * Default is none. */ shadow: string; /** * Color of the Enter Full Screen Page border. * Default is white. */ borderColor: string; /** * Corner radius of the Enter Full Screen Page. * Default is dynamically configured per device at runtime. */ borderCornerRadius: string; /** * Thickness of the Enter Full Screen Page. * Default is dynamically configured per device at runtime. */ borderWidth: string; /** * Constructor for FaceTecEnterFullScreenCustomization object. * * @param directoryForImageFiles - (optional) specify a custom directory to search for default image path names. */ constructor(directoryForImageFiles?: string); } /** * Customize the FaceTec Session Overlay. * The FaceTec Session Overlay separates the FaceTec I