Skip to main content

Interface: MountConfiguratorPayload

Extends​

Properties​

CDNPath?​

optional CDNPath: string

URL to storage/CDN

Inherited from​

EmbedPayloadPartial.CDNPath

appUrl?​

optional appUrl: string

App url for AR return path

baseURL?​

optional baseURL: string

URL to page API

Inherited from​

EmbedPayloadPartial.baseURL

customerId​

customerId: string

ID of current customer from witch fetch data

Inherited from​

EmbedPayloadPartial.customerId

elementId?​

optional elementId: string

Deprecated​

ID of HTML element on which mount tree. No longer supported. Please use uid and data-mimeeq-short-code combination instead

Inherited from​

EmbedPayloadPartial.elementId

finishScreen?​

optional finishScreen: boolean

If true modular will display Finish Screen on load

hash?​

optional hash: string

Currently showed tab hash. Used only to control product tabs through history. It's mostly needed for initial render.

isFavourite?​

optional isFavourite: boolean

If true Favourites will be available

isModular?​

optional isModular: boolean

If true then render modular configurator

legacy?​

optional legacy: boolean

If true some parameter will use old default values for regular configurator

locale​

locale: string

Code of current locale

Inherited from​

EmbedPayloadPartial.locale

modularLegacy?​

optional modularLegacy: boolean

If true some parameter will use old default values for modular

onEventDispatch?​

optional onEventDispatch: EventDispatchCallback<any>

Custom events callback

Inherited from​

EmbedPayloadPartial.onEventDispatch

renderOnMount?​

optional renderOnMount: boolean

If true embed will be rendered into DOM on mount

shortCode?​

optional shortCode: string

Modular scene short code

uid​

uid: string

Embed instance unique id. Typically, embed shortcode. If passed app will try to mount into html element with data-mimmeq-shortcode set to this value and use env for this id

Inherited from​

EmbedPayloadPartial.uid

variant?​

optional variant: string

Variant of configurator. Following values are available: Standard - full version of configurator, preview - shows in preview mode (it allows for inactive products), selector - Instead of summary screen it allows to provide callback function to be called, iframe - renders in iframe. Some functionality is blocked in this mode. Possible values are 'standard'|'preview'|'selector'|'iframe'|'configuratorOnly'

variantCode​

variantCode: string

Configuration to load

withBackButton?​

optional withBackButton: boolean

If true configurator will display back button on header

withWatcher?​

optional withWatcher: boolean

If true will assign "sandbox" logic to components

Inherited from​

EmbedPayloadPartial.withWatcher