Skip to main content

Interface: RenderPayload

Properties​

allowScaling?​

optional allowScaling: boolean

If true, AR view will allow user scaling

arShortCode?​

optional arShortCode: string

Ar short code required for AR landing page

basketSettings?​

optional basketSettings: Partial<BasketSettings>

cartReferenceCode?​

optional cartReferenceCode: string

Cart ID or reference code for basket content preview

categoryPath?​

optional categoryPath: string

Currently selected Product Category slug path

embedType?​

optional embedType: EmbedType

Embed type to render

favouritePath?​

optional favouritePath: string

Currently selected Favourite Collection slug path

finishScreen?​

optional finishScreen: boolean

If true, modular will open to Elements List rather then scene on load

hash?​

optional hash: string

If configurator, selected tab hash

incompatible?​

optional incompatible: boolean

If true, AR landing page will show incompatible view

isFavourite?​

optional isFavourite: boolean

If true, favourites are open or user's saved scene is loaded at modular

locale?​

optional locale: string

Language to use. If not provided it will use customer default

manualSort?​

optional manualSort: boolean

If true, Product Group List will sort product's as set by customer rather than by default A-Z.

onEventDispatch()?​

optional onEventDispatch: (eventPayload) => Promisable<void>

Callback for emitted events

Parameters​

• eventPayload: NavigationEventPayload

Returns​

Promisable<void>

onLoginSuccess?​

optional onLoginSuccess: OnLoginSuccess

Callback fired on successful sign in. It's called with Payload data

productGroupId?​

optional productGroupId: string

If provided, Product List embed will show product from specified product group

sceneShortCode?​

optional sceneShortCode: string

In modular, scene short code to load

theme?​

optional theme: Partial<EmbedTheme>

uiConfig?​

optional uiConfig: Partial<UiVisibilityConfig>

variant?​

optional variant: string

Embed variant. Depending on selected embed type these may vary.

variantCode?​

optional variantCode: string

Variant code of product to render in both standard and modular configurator

withBackButton?​

optional withBackButton: boolean

If true, configurator will render Back Button

withModal?​

optional withModal: boolean

If true, it will render embed in modal