capacitor-plugin-scanbot-sdk
Version:
Scanbot Document and Barcode Scanner SDK for Capacitor
66 lines (59 loc) • 2.33 kB
TypeScript
import { BackgroundStyle, StyledText } from '../../ui_v2/common/Common';
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
Configure the captions of the user guidance hints for different scanning states.
*/
export declare class CheckScannerGuidanceStates extends PartiallyConstructible {
/**
The user guidance text displayed when no check is found. Initial state.
Default is "?checkUserGuidanceNoCheckFound"
*/
noCheckFound: string;
/**
The user guidance text displayed when a check presence was detected and scanning is in progress.
Default is "?checkUserGuidanceScanningProgress"
*/
scanningProgress: string;
/**
The user guidance text displayed when it is too dark to capture an adequate image.
Default is "?checkUserGuidanceTooDark"
*/
tooDark: string;
/**
The user guidance text displayed when the detected check is too far away and appears too small.
Default is "?checkUserGuidanceTooSmall"
*/
tooSmall: string;
/**
The user guidance text displayed when the detected check is not in a good perspective (device tilted).
Default is "?checkUserGuidanceBadPerspective"
*/
badPerspective: string;
/** @param source {@displayType `DeepPartial<CheckScannerGuidanceStates>`} */
constructor(source?: DeepPartial<CheckScannerGuidanceStates>);
}
/**
Configuration of the hints guiding users through the check scanning process.
*/
export declare class CheckScannerGuidanceConfiguration extends PartiallyConstructible {
/**
Determines whether the user guidance hints should be visible (enabled).
Default is true
*/
visibility: boolean;
/**
Configure the text style for the user guidance hints.
*/
title: StyledText;
/**
Configure the background style for the user guidance hints.
*/
background: BackgroundStyle;
/**
Configure the captions of the user guidance hints for different states.
*/
statesTitles: CheckScannerGuidanceStates;
/** @param source {@displayType `DeepPartial<CheckScannerGuidanceConfiguration>`} */
constructor(source?: DeepPartial<CheckScannerGuidanceConfiguration>);
}