scanbot-web-sdk/@types/ui2/configuration/vin/VINScannerScreenTextLocalization.d.ts

Scanbot Web Document and Barcode Scanner SDK

import type { DeepPartial } from "../utils";
/**
Configuration of the all strings for generic text scanner screen.
*/
export declare class VinScannerScreenTextLocalization {
    /**
      Title for the top bar.
      @defaultValue "VIN Scanner";
      */
    topBarTitle: string;
    /**
      Cancel button text for the top bar.
      @defaultValue "Cancel";
      */
    topBarCancelButton: string;
    /**
      Text for the top user guidance caption.
      @defaultValue "Point the camera at the VIN";
      */
    topUserGuidance: string;
    /**
      Text for the user guidance caption below the finder view.
      @defaultValue "Looking for VIN...";
      */
    finderViewUserGuidance: string;
    /**
      Title for the introduction screen.
      @defaultValue "How to scan a VIN";
      */
    introScreenTitle: string;
    /**
      Start scanning button text for the introduction screen.
      @defaultValue "Start Scanning";
      */
    introScreenDoneButton: string;
    /**
      The text explanation for the introduction screen.
      @defaultValue "A VIN (Vehicle Identification Number) is a unique code you'll find on a vehicle's windshield or on the inside of the driver's door. \n\nTo scan, simply point your camera at the VIN, ensuring it's within the frame. The VIN will be automatically extracted.\n\nTap 'Start Scanning' to begin.";
      */
    introScreenText: string;
    /**
      Caption for the success overlay.
      @defaultValue "Scanned successfully";
      */
    completionOverlaySuccessMessage: string;
    /**
      Accessibility description for the 'open introduction screen' button in top bar.
      @defaultValue "Open VIN Scanner introduction";
      */
    accessibilityDescriptionOpenIntroScreenButton: string;
    /**
      Accessibility description for the 'done'/'start scanning' button in the introduction screen.
      @defaultValue "Start VIN scanning";
      */
    accessibilityDescriptionIntroScreenDoneButton: string;
    /**
      Accessibility description for the 'cancel' button in the top bar.
      @defaultValue "Cancel VIN scanning";
      */
    accessibilityDescriptionCancelButton: string;
    /**
      Title for the text pattern confirmation alert.
      @defaultValue "VIN detected";
      */
    vinConfirmationAlertTitle: string;
    /**
      Cancel button text for the text pattern confirmation alert.
      @defaultValue "Cancel";
      */
    vinConfirmationAlertCancelButton: string;
    /**
      Submit button text for the text pattern confirmation alert.
      @defaultValue "Submit";
      */
    vinConfirmationAlertSubmitButton: string;
    /**
      Accessibility description for the cancel button in the text pattern confirmation alert.
      @defaultValue "Cancel VIN scanning";
      */
    accessibilityDescriptionConfirmationCancelButton: string;
    /**
      Accessibility description for the submit button in the text pattern confirmation alert.
      @defaultValue "Submit VIN scan result";
      */
    accessibilityDescriptionConfirmationSubmitButton: string;
    /**
      Accessibility description for the flash button.
      @defaultValue "Toggle flash";
      */
    accessibilityDescriptionFlashButton: string;
    /**
      Accessibility description for the zoom button.
      @defaultValue "Toggle camera zoom";
      */
    accessibilityDescriptionZoomButton: string;
    /**
      Accessibility description for the flip camera button.
      @defaultValue "Flip camera";
      */
    accessibilityDescriptionFlipCameraButton: string;
    /**
      The title of the camera permission dialog.
      @defaultValue "Camera permission denied!";
      */
    cameraPermissionEnableCameraTitle: string;
    /**
      The explanation text of the camera permission dialog.
      @defaultValue "Please allow the usage of the camera to start the scanning process.";
      */
    cameraPermissionEnableCameraExplanation: string;
    /**
      The 'enable' button title of the camera permission dialog.
      @defaultValue "Grant permission";
      */
    cameraPermissionEnableCameraButton: string;
    /**
      The 'close' button title of the camera permission dialog.
      @defaultValue "Close";
      */
    cameraPermissionCloseButton: string;
    /**
      The accessibility hint for the 'enable' button of the camera permission dialog.
      @defaultValue "Tap to grant camera permission";
      */
    accessibilityDescriptionCameraPermissionEnableCameraButton: string;
    /**
      The accessibility hint for the 'close' button of the camera permission dialog.
      @defaultValue "Close screen without granting permission";
      */
    accessibilityDescriptionCameraPermissionCloseButton: string;
    /** @param source {@displayType `DeepPartial<VinScannerScreenTextLocalization>`} */
    constructor(source?: DeepPartial<VinScannerScreenTextLocalization>);
}