capacitor-plugin-scanbot-sdk/dist/esm/ui_v2/common/UserGuidanceConfiguration.d.ts

Scanbot Document and Barcode Scanner SDK for Capacitor

import { BackgroundStyle, IconStyle, StyledText } from '../../ui_v2/common/Common';
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
Configuration of the hint guiding users through the scanning process.
*/
export declare class UserGuidanceConfiguration extends PartiallyConstructible {
    /**
      Determines whether the user guidance is visible or not.
      
      Default is true
      */
    visible: boolean;
    /**
      The title of the user guidance.
      */
    title: StyledText;
    /**
      The background style used for the user guidance.
      */
    background: BackgroundStyle;
    /** @param source {@displayType `DeepPartial<UserGuidanceConfiguration>`} */
    constructor(source?: DeepPartial<UserGuidanceConfiguration>);
}
/**
Configuration of the hint (containing an icon) guiding users through the scanning process.
*/
export declare class IconUserGuidanceConfiguration extends PartiallyConstructible {
    /**
      Determines whether the user guidance is visible or not.
      
      Default is true
      */
    visible: boolean;
    /**
      Configuration of the icon appearance.
      */
    icon: IconStyle;
    /**
      The title of the user guidance.
      */
    title: StyledText;
    /**
      Configuration of the background appearance for the user guidance hints.
      */
    background: BackgroundStyle;
    /** @param source {@displayType `DeepPartial<IconUserGuidanceConfiguration>`} */
    constructor(source?: DeepPartial<IconUserGuidanceConfiguration>);
}