react-native-scanbot-sdk

/// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten. /// Generated from rtu-ui-v2/schemas/mrz/MRZScannerScreenConfiguration.yaml import { MrzScannerConfiguration } from '../../mrz/MrzTypes'; import { ActionBarConfiguration } from '../../ui_v2/common/ActionBarConfiguration'; import { CameraConfiguration } from '../../ui_v2/common/CameraConfiguration'; import { CameraPermissionScreen } from '../../ui_v2/common/CameraPermission'; import { BackgroundStyle, ButtonConfiguration, EdgeInsets, ForegroundStyle, IconButton, IconStyle, Palette, RoundButton, Sound, StyledText, Vibration, } from '../../ui_v2/common/Common'; import { ScanCompletionOverlay } from '../../ui_v2/common/ScanCompletionOverlay'; import { TopBarConfiguration } from '../../ui_v2/common/TopBarConfiguration'; import { UserGuidanceConfiguration } from '../../ui_v2/common/UserGuidanceConfiguration'; import { FinderCorneredStyle, PermanentViewFinderConfiguration, } from '../../ui_v2/common/ViewFinderConfiguration'; import { MrzFinderLayoutPreset, TwoLineMrzFinderLayoutPreset, } from '../../ui_v2/mrz/MRZFinderLayoutPreset'; import { MrzScannerIntroScreenConfiguration } from '../../ui_v2/mrz/MRZScannerIntroScreenConfiguration'; import { MrzScannerScreenTextLocalization } from '../../ui_v2/mrz/MRZScannerScreenTextLocalization'; import { AspectRatio } from '../../utils/geometry/Geometry'; import { DeepPartial, PartiallyConstructible } from '../../utils/utils'; /** Configuration of the screen for detecting MRZ (Machine-readable zones) of various documents. */ export class MrzScannerScreenConfiguration extends PartiallyConstructible { /** Version number of the configuration object. Default is "1.0" */ public readonly version: string = '1.0'; /** The configuration object should be applied for this screen. Default is "MrzScanner" */ public readonly screen: string = 'MrzScanner'; /** Configuration of the all strings for MRZ scanner screen. */ public localization: MrzScannerScreenTextLocalization = new MrzScannerScreenTextLocalization({}); /** Define the screen's base color values from which other colors are derived. */ public palette: Palette = new Palette({}); /** The background color of the MRZ scanner screen. Default is "?sbColorSurfaceLow" */ public backgroundColor: string = '?sbColorSurfaceLow'; /** Configuration of the camera behavior. */ public cameraConfiguration: CameraConfiguration = new CameraConfiguration({ orientationLockMode: 'PORTRAIT', }); /** Configuration of the dialog for requesting camera permissions. */ public cameraPermission: CameraPermissionScreen = new CameraPermissionScreen({ statusBarMode: 'DARK', background: '?sbColorSurface', iconBackground: '?sbColorOutline', icon: new IconStyle({ visible: true, color: '?sbColorOnSurface' }), enableCameraButton: new ButtonConfiguration({ visible: true, text: '?cameraPermissionEnableCameraButton', accessibilityDescription: '?accessibilityDescriptionCameraPermissionEnableCameraButton', background: new BackgroundStyle({ strokeColor: '?sbColorPrimary', fillColor: '?sbColorPrimary', strokeWidth: 0.0, }), foreground: new ForegroundStyle({ iconVisible: false, color: '?sbColorOnPrimary', useShadow: false, }), }), closeButton: new ButtonConfiguration({ visible: true, text: '?cameraPermissionCloseButton', accessibilityDescription: '?accessibilityDescriptionCameraPermissionCloseButton', background: new BackgroundStyle({ strokeColor: '#00000000', fillColor: '#00000000', strokeWidth: 0.0, }), foreground: new ForegroundStyle({ iconVisible: false, color: '?sbColorPrimary', useShadow: false, }), }), enableCameraTitle: new StyledText({ text: '?cameraPermissionEnableCameraTitle', color: '?sbColorOnSurface', }), enableCameraExplanation: new StyledText({ text: '?cameraPermissionEnableCameraExplanation', color: '?sbColorOnSurfaceVariant', }), }); /** Configuration of the top user guidance. */ public topUserGuidance: UserGuidanceConfiguration = new UserGuidanceConfiguration({ title: new StyledText({ text: '?topUserGuidance' }), }); /** Configuration of the user guidance below finder view. */ public finderViewUserGuidance: UserGuidanceConfiguration = new UserGuidanceConfiguration({ title: new StyledText({ text: '?finderViewUserGuidance' }), }); /** Configuration of the top bar on the MRZ scanner screen. */ public topBar: TopBarConfiguration = new TopBarConfiguration({ title: new StyledText({ visible: true, text: '?topBarTitle' }), cancelButton: new ButtonConfiguration({ text: '?topBarCancelButton', accessibilityDescription: '?accessibilityDescriptionCancelButton', background: new BackgroundStyle({ strokeColor: '#00000000', fillColor: '#00000000', strokeWidth: 0.0, }), foreground: new ForegroundStyle({ color: '?sbColorOnPrimary' }), }), }); /** Configuration of the button in the top bar that opens the introduction screen. */ public topBarOpenIntroScreenButton: IconButton = new IconButton({ color: '?sbColorOnPrimary', accessibilityDescription: '?accessibilityDescriptionOpenIntroScreenButton', }); /** Configuration of the introduction screen for the MRZ scanner. */ public introScreen: MrzScannerIntroScreenConfiguration = new MrzScannerIntroScreenConfiguration( {} ); /** Configuration of the action bar. */ public actionBar: ActionBarConfiguration = new ActionBarConfiguration({ flipCameraButton: new RoundButton({ visible: false, accessibilityDescription: '?accessibilityDescriptionFlipCameraButton', backgroundColor: '?sbColorSurfaceHigh', foregroundColor: '?sbColorOnPrimary', activeBackgroundColor: '?sbColorWarning', activeForegroundColor: '#1C1B1F', }), }); /** Configuration of the view finder. */ public viewFinder: PermanentViewFinderConfiguration = new PermanentViewFinderConfiguration({ style: new FinderCorneredStyle({ strokeColor: '?sbColorSurface', strokeWidth: 2.0 }), aspectRatio: new AspectRatio({ width: -1.0, height: -1.0 }), minimumInsets: new EdgeInsets({ top: 24.0, left: 24.0, bottom: 24.0, right: 24.0 }), }); /** Configuration of the MRZ scanner. */ public scannerConfiguration: MrzScannerConfiguration = new MrzScannerConfiguration({}); /** Configuration of the overlay text inside finder. */ public mrzExampleOverlay: MrzFinderLayoutPreset = new TwoLineMrzFinderLayoutPreset({}); /** Configuration of the success overlay. */ public successOverlay: ScanCompletionOverlay = new ScanCompletionOverlay({}); /** Configuration of the scan confirmation sound. */ public sound: Sound = new Sound({}); /** Configuration of the vibration feedback. */ public vibration: Vibration = new Vibration({}); /** If enabled, the screen will not turn off while the barcode scanner is active. (Android only). Default is true */ public keepScreenOn: boolean = true; /** @param source {@displayType `DeepPartial<MrzScannerScreenConfiguration>`} */ public constructor(source: DeepPartial<MrzScannerScreenConfiguration> = {}) { super(); if (source.version !== undefined) { this.version = source.version; } if (source.screen !== undefined) { this.screen = source.screen; } if (source.localization !== undefined) { this.localization = new MrzScannerScreenTextLocalization(source.localization); } if (source.palette !== undefined) { this.palette = new Palette(source.palette); } if (source.backgroundColor !== undefined) { this.backgroundColor = source.backgroundColor; } if (source.cameraConfiguration !== undefined) { this.cameraConfiguration = new CameraConfiguration(source.cameraConfiguration); } if (source.cameraPermission !== undefined) { this.cameraPermission = new CameraPermissionScreen(source.cameraPermission); } if (source.topUserGuidance !== undefined) { this.topUserGuidance = new UserGuidanceConfiguration(source.topUserGuidance); } if (source.finderViewUserGuidance !== undefined) { this.finderViewUserGuidance = new UserGuidanceConfiguration(source.finderViewUserGuidance); } if (source.topBar !== undefined) { this.topBar = new TopBarConfiguration(source.topBar); } if (source.topBarOpenIntroScreenButton !== undefined) { this.topBarOpenIntroScreenButton = new IconButton(source.topBarOpenIntroScreenButton); } if (source.introScreen !== undefined) { this.introScreen = new MrzScannerIntroScreenConfiguration(source.introScreen); } if (source.actionBar !== undefined) { this.actionBar = new ActionBarConfiguration(source.actionBar); } if (source.viewFinder !== undefined) { this.viewFinder = new PermanentViewFinderConfiguration(source.viewFinder); } if (source.scannerConfiguration !== undefined) { this.scannerConfiguration = new MrzScannerConfiguration(source.scannerConfiguration); } if (source.mrzExampleOverlay !== undefined) { this.mrzExampleOverlay = MrzFinderLayoutPreset.From(source.mrzExampleOverlay); } if (source.successOverlay !== undefined) { this.successOverlay = new ScanCompletionOverlay(source.successOverlay); } if (source.sound !== undefined) { this.sound = new Sound(source.sound); } if (source.vibration !== undefined) { this.vibration = new Vibration(source.vibration); } if (source.keepScreenOn !== undefined) { this.keepScreenOn = source.keepScreenOn; } } }