Class MrzScannerScreenConfiguration

Configuration of the action bar.

Default Value

new ActionBarConfiguration({
    "flipCameraButton": new RoundButton({
        "visible": false,
        "accessibilityDescription": "?accessibilityDescriptionFlipCameraButton",
        "backgroundColor": "?sbColorSurfaceHigh",
        "foregroundColor": "?sbColorOnPrimary",
        "activeBackgroundColor": "?sbColorWarning",
        "activeForegroundColor": "#1C1B1F"
    })
});
Copy

The background color of the MRZ scanner screen.

Default Value

"?sbColorSurfaceLow";
Copy

Configuration of the camera behavior.

Default Value

new CameraConfiguration({});
Copy

Configuration of the dialog for requesting camera permissions.

Default Value

new CameraPermissionScreen({
    "background": "?sbColorSurface",
    "iconBackground": "?sbColorOutline",
    "icon": new IconStyle({
        "visible": true,
        "color": "?sbColorOnSurface"
    }),
    "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"
    })
});
Copy

Configuration of the user guidance below finder view.

Default Value

new UserGuidanceConfiguration({
    "title": new StyledText({
        "text": "?finderViewUserGuidance"
    })
});
Copy

Configuration of the introduction screen for the MRZ scanner.

Default Value

new MrzScannerIntroScreenConfiguration({});
Copy

Configuration of the all strings for MRZ scanner screen.

Default Value

new MrzScannerScreenTextLocalization({});
Copy

Configuration of the overlay text inside finder.

Default Value

new TwoLineMrzFinderLayoutPreset({});
Copy

Define the screen's base color values from which other colors are derived.

Default Value

new Palette({});
Copy

Configuration of the MRZ scanner.

Default Value

new MrzScannerConfiguration({});
Copy

The configuration object should be applied for this screen.

Default Value

"MrzScanner";
Copy

Configuration of the scan confirmation sound.

Default Value

new Sound({});
Copy

Configuration of the success overlay.

Default Value

new ScanCompletionOverlay({});
Copy

Configuration of the top bar on the MRZ scanner screen.

Default Value

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"
        })
    })
});
Copy

Configuration of the button in the top bar that opens the introduction screen.

Default Value

new IconButton({
    "color": "?sbColorOnPrimary",
    "accessibilityDescription": "?accessibilityDescriptionOpenIntroScreenButton"
});
Copy

Configuration of the top user guidance.

Default Value

new UserGuidanceConfiguration({
    "title": new StyledText({
        "text": "?topUserGuidance"
    })
});
Copy

Version number of the configuration object.

Default Value

"1.0";
Copy

Configuration of the vibration feedback.

Default Value

new Vibration({});
Copy

Configuration of the view finder.

Default Value

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
    })
});
Copy