The main configuration class for the Widget Manager. Containing both required and optional configuration properties.

Hierarchy (view full)

Constructors

Properties

additionalTaxCategories: {
    [key: string]: number;
} = {}

Additional indicative tax categories which the shop may have, keyed by their respective codes.

allowedOrigins: string[] = ...

A list of allowed origins for the SDK to communicate with

currencyCode: string

The ISO 4217 currency code, e.g. "USD"

debugWidget: boolean = false

Enables the debug console widget. When true, TecsafeWidgetManager.createDebugWidget may be used to mount the TECSAFE debug console. Intended for development and integration testing only - leave it off in production.

iframeTransition: string = 'height 0.3s ease-in-out'

Iframe styles.transition property

language: string

The RFC 4647 language tag representing the user's preferred language, e.g. "en-US"

priceCachingSeconds: number = 600

The duration in seconds for which prices should be cached. Set to 0 to disable caching.

priceMode: "gross" | "net"

The price mode for the shop, either 'gross' or 'net'.

sdkDebugger: boolean = false

Injects the SDK debug overlay into the host page. When true, the widget manager renders a single collapsible overlay that logs the postMessage traffic of every widget, can send arbitrary messages to a selected widget, and can reset a widget. Intended for development and integration testing only - leave it off in production.

taxCategories: {
    AA: number;
    S: number;
}

The indicative tax categories for the shop, keyed by their respective codes.

tecsafeArticles: TecsafeArticle[]

The TECSAFE articles listed by the shop. Sent to widgets via OutMessageSetTecsafeArticles, either proactively or in response to a InMessageRequestTecsafeArticles.

trackingAllowed: boolean

Will activate customer tracking. Make sure to request tracking consent from your customer and set accordingly.

widgetBaseURL: string = 'https://app-ui.tecsafe.de/iframe'

The base URL for the widget UIs