Class IntroductionScreenConfiguration

Configuration of the introduction screen for the document scanner.

Hierarchy

  • PartiallyConstructible
    • IntroductionScreenConfiguration

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";

Configure the scanning steps of the introduction screen.

Default Value

[new IntroListEntry({
"image": new DocumentIntroImage({}),
"text": new StyledText({
"text": "?cameraIntroItem1",
"color": "?sbColorOnSurface"
})
}), new IntroListEntry({
"image": new NoIntroImage({}),
"text": new StyledText({
"text": "?cameraIntroItem2",
"color": "?sbColorOnSurface"
})
}), new IntroListEntry({
"image": new NoIntroImage({}),
"text": new StyledText({
"text": "?cameraIntroItem3",
"color": "?sbColorOnSurface"
})
}), new IntroListEntry({
"image": new NoIntroImage({}),
"text": new StyledText({
"text": "?cameraIntroItem4",
"color": "?sbColorOnSurface"
})
})];
showAutomatically: boolean

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

Default Value

false;
subtitle: StyledText

The subtitle of the introduction screen.

Default Value

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

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

Default Value

new StyledText({
"text": "?cameraIntroTitle",
"color": "?sbColorOnSurface"
});
topBarDoneButton: ButtonConfiguration

Configuration of the 'done' button, located in the top bar.

Default Value

new ButtonConfiguration({
"visible": true,
"text": "?cameraIntroDoneButton",
"accessibilityDescription": "?accessibilityDescriptionCameraIntroDoneButton",
"background": new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "#00000000",
"strokeWidth": 0.0
}),
"foreground": new ForegroundStyle({
"iconVisible": true,
"color": "?sbColorPrimary",
"useShadow": false
})
});

Generated using TypeDoc