capacitor-plugin-scanbot-sdk/dist/esm/ui_v2/vin/VINScannerIntroScreenConfiguration.d.ts

Scanbot Document and Barcode Scanner SDK for Capacitor

import { ButtonConfiguration, StyledText } from '../../ui_v2/common/Common';
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
The image for the introduction screen of a VIN scanner screen.
*/
export type VinScannerIntroImage = VinIntroDefaultImage | VinIntroNoImage | VinIntroCustomImage;
/**
The default image for the introduction screen.
*/
export declare class VinIntroDefaultImage extends PartiallyConstructible {
    readonly _type: 'VINIntroDefaultImage';
    /** @param source {@displayType `DeepPartial<VinIntroDefaultImage>`} */
    constructor(source?: DeepPartial<VinIntroDefaultImage>);
}
/**
No image for the introduction screen.
*/
export declare class VinIntroNoImage extends PartiallyConstructible {
    readonly _type: 'VINIntroNoImage';
    /** @param source {@displayType `DeepPartial<VinIntroNoImage>`} */
    constructor(source?: DeepPartial<VinIntroNoImage>);
}
/**
A custom image for the introduction screen.
*/
export declare class VinIntroCustomImage extends PartiallyConstructible {
    readonly _type: 'VINIntroCustomImage';
    /**
      The web or file URI to the image.
      */
    uri: string;
    /** @param source {@displayType `DeepPartial<VinIntroCustomImage>`} */
    constructor(source?: DeepPartial<VinIntroCustomImage>);
}
/**
Configuration of the introduction screen for the VIN scanner.
*/
export declare class VinScannerIntroScreenConfiguration extends PartiallyConstructible {
    /**
      The image for the introduction screen.
      */
    image: VinScannerIntroImage;
    /**
      The background color of the introduction screen.
      
      Default is "?sbColorSurface"
      */
    backgroundColor: string;
    /**
      The divider color of the introduction screen.
      
      Default is "?sbColorOutline"
      */
    dividerColor: string;
    /**
      The handle color of the introduction screen.
      
      Default is "?sbColorOutline"
      */
    handlerColor: string;
    /**
      Determines whether the introduction screen should automatically be shown or not when the scanning session starts.
      
      Default is false
      */
    showAutomatically: boolean;
    /**
      The title of the introduction screen, located in the top bar.
      */
    title: StyledText;
    /**
      The text explanation of the introduction screen.
      */
    explanation: StyledText;
    /**
      Configuration of the 'Done' / 'Start scanning' button.
      */
    doneButton: ButtonConfiguration;
    /** @param source {@displayType `DeepPartial<VinScannerIntroScreenConfiguration>`} */
    constructor(source?: DeepPartial<VinScannerIntroScreenConfiguration>);
}