STRICH Barcode Scanning SDK API Reference
    Preparing search index...

    Interface PopupConfiguration

    Popup scanner configuration

    interface PopupConfiguration {
        detectionHandler?: (detections: CodeDetection[]) => boolean;
        feedback?: FeedbackConfiguration;
        frameSource?: FrameSourceConfiguration;
        labels?: { cancel?: string; title?: string };
        overlay?: OverlayConfiguration;
        resolution?: "hd" | "full-hd";
        style?: {
            cancelButtonBackgroundColor?: string;
            cancelButtonColor?: string;
            titleBackgroundColor?: string;
            titleColor?: string;
        };
        symbologies: (SymbologyName | SymbologySpec)[];
    }
    Index

    Properties

    detectionHandler? feedback? frameSource? labels? overlay? resolution? style? symbologies

    Properties

    detectionHandler?: (detections: CodeDetection[]) => boolean

    An optional handler for detections.

    Receives barcode detections and must return true if scanning should stop, or false if scanning should continue. Any truthy value will be interpreted as true.

    feedback?: FeedbackConfiguration

    Optional configuration for audible and haptic feedback.

    frameSource?: FrameSourceConfiguration

    Optional Frame source configuration, will override PopupConfiguration.resolution setting.

    labels?: { cancel?: string; title?: string }

    Optional overrides for textual content.

    Type Declaration

    • Optionalcancel?: string

      The text to display on the cancel button in the dialog bottom area.

      If no value is supplied, a locale-dependent default text will be used.

    • Optionaltitle?: string

      The text to display in the dialog header area.

      If no value is supplied, a locale-dependent default text will be used.

    overlay?: OverlayConfiguration

    Optional Overlay configuration.

    resolution?: "hd" | "full-hd"

    The camera resolution to use.

    hd
    style?: {
        cancelButtonBackgroundColor?: string;
        cancelButtonColor?: string;
        titleBackgroundColor?: string;
        titleColor?: string;
    }

    Optional overrides for title area and cancel button.

    Type Declaration

    • OptionalcancelButtonBackgroundColor?: string

      Background color to use for cancel button. Must be specified in rgb() or rgba() notation.

      transparent
    • OptionalcancelButtonColor?: string

      Color to use for cancel button outline and text. Must be specified in rgb() or rgba() notation.

      rgba(15,42,66,0.9)
    • OptionaltitleBackgroundColor?: string

      Background color to use for title. Must be specified in rgb() or rgba() notation.

      rgba(15,42,66,0.9)
    • OptionaltitleColor?: string

      Background color to use for title text. Must be specified in rgb() notation.

      rgb(236,237,237)
    symbologies: (SymbologyName | SymbologySpec)[]

    The barcode symbologies that should be detected.

    See EngineConfiguration#symbologies for details.

    Settings

    Member Visibility

    On This Page

    Properties