Interface OverlayConfiguration

Overlay configuration

Hierarchy

  • OverlayConfiguration

Properties

customLogoSrc? focusOnTap? showCameraSelector? showDetections? showFlashlight? showTargetingLine?

Properties

Optional customLogoSrc

customLogoSrc?: string

Override the STRICH logo displayed in the bottom-right corner with a custom image.

The image is supplied as a URL (e.g. https://example.com/assets/overlay.png) or inline as a data URL (recommended, avoids network request). The image should have a transparent background (WebP or PNG format recommended) and a recommended size of 140x30 pixels.

This is an enterprise-only capability.

Optional focusOnTap

focusOnTap?: boolean

Default

true (where supported)

Optional showCameraSelector

showCameraSelector?: boolean

Indicate if the camera selector should be shown in the overlay.

Default

true

Optional showDetections

showDetections?: boolean

Indicate if the overlay should draw the bounding boxes of detected barcodes on top of the camera preview.

Default

true

Optional showFlashlight

showFlashlight?: boolean

Indicate if the flashlight toggle should be shown in the overlay.

Flashlight functionality is not supported in some browsers.

Default

true

Optional showTargetingLine

showTargetingLine?: boolean

Indicate if a horizontal line should be drawn to aid in positioning 1D barcodes.

Default

true

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc