Class MrzScannerIntroScreenConfiguration

Configuration of the introduction screen for the MRZ scanner.

Hierarchy

  • PartiallyConstructible
    • MrzScannerIntroScreenConfiguration

Constructors

Properties

backgroundColor: string

The background color of the introduction screen.

Default Value

"?sbColorSurface";
dividerColor: string

The divider color of the introduction screen.

Default Value

"?sbColorOutline";

Configuration of the 'Done' / 'Start scanning' button.

Default Value

new ButtonConfiguration({
"text": "?introScreenDoneButton",
"accessibilityDescription": "?accessibilityDescriptionIntroScreenDoneButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "?sbColorPrimary",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"color": "?sbColorOnPrimary"
})
});
handlerColor: string

The handle color of the introduction screen.

Default Value

"?sbColorOutline";

The image for the introduction screen.

Default Value

new MrzIntroDefaultImage({});
showAutomatically: boolean

Determines whether the introduction screen should automatically be shown or not when the scanning session starts.

Default Value

false;

The text explanation of the introduction screen.

Default Value

new StyledText({
"text": "?introScreenText",
"color": "?sbColorOnSurface"
});
title: StyledText

The title of the introduction screen, located in the top bar.

Default Value

new StyledText({
"text": "?introScreenTitle",
"color": "?sbColorOnSurface"
});

Generated using TypeDoc