Skip to main content

Interface: RenderPayload

Configuration for rendering a specific embed type.

This interface provides comprehensive control over what type of embed to render and how it should be configured. It allows for dynamic switching between different embed types (configurator, product list, authentication, etc.) and configuring their behavior at runtime.

The render payload is used with the render method returned by the mount function to control what content is displayed in a mounted Mimeeq component.

Properties​

allowScaling?​

optional allowScaling: boolean

Enables model scaling in AR experiences.

When true, users can resize the 3D model in their AR experience. This allows for flexible placement in different environments. When false, models appear at their actual physical scale.

arShortCode?​

optional arShortCode: string

AR shortcode that identifies the 3D model to load.

This code is specific to AR experiences and links to the properly optimized 3D model files (USDZ for iOS, GLB for Android) that represent the configured product.

basketSettings?​

optional basketSettings: Partial<BasketSettings>

Shopping basket configuration.

Controls how the shopping basket behaves within the configurator, including button placements and integration settings.

cartReferenceCode?​

optional cartReferenceCode: string

Cart ID or reference code for basket content preview.

Used to load a specific cart's contents when displaying the basket. This allows viewing or editing an existing cart rather than starting fresh.

categoryPath?​

optional categoryPath: string

Currently selected Product Category path.

This identifies which category of products to display when rendering a product list. It should be the slug path for the category.

embedType?​

optional embedType: EmbedType

Type of embed to render.

Determines which embed experience to display in the mounted component. Options include:

  • CONFIGURATOR: Standard product configurator
  • MODULAR_CONFIGURATOR: Modular product configurator
  • PRODUCT_LIST: List of available products
  • AR_LANDING: Augmented reality experience
  • LOGIN: Authentication form
  • USER_PROFILE: User account management
  • FORGOT_PASSWORD: Password recovery flow

favouritePath?​

optional favouritePath: string

Path to the currently selected Favourite Collection.

This identifies which favorite collection to display when rendering a favorites listing. It should be the slug path for the collection.

finishScreen?​

optional finishScreen: boolean

Shows the elements list on load for modular products.

When true, modular configurators will initially display the elements list (finish screen) rather than the 3D scene. This is useful for providing a product selection interface before scene arrangement.

hash?​

optional hash: string

Initial tab to display when a configurator loads.

This URL hash fragment identifies which product tab should be active when the configurator first loads. This is useful for deep-linking to specific sections like descriptions, galleries, or materials.

incompatible?​

optional incompatible: boolean

Shows the incompatible device view for AR experiences.

When true, displays a message informing users that their device doesn't support AR functionality. This is useful for graceful degradation on unsupported browsers or devices.

isFavourite?​

optional isFavourite: boolean

Enables favorites functionality or loads a saved scene.

When true, either enables the favorites interface or loads a user's saved scene in modular mode, depending on the embed type.

locale?​

optional locale: string

Language code for the embed UI.

This sets the language used throughout the interface, including labels, button text, and error messages. Uses standard language codes like 'en', 'fr', 'de'.

manualSort?​

optional manualSort: boolean

Enables manual product sorting in product listings.

When true, products in the list will be displayed in the order specified by the administrator rather than alphabetically or by another automatic order.

onEventDispatch()?​

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

Callback function for handling events from the embed.

This function is called whenever a significant event occurs within the embed, such as navigation changes, configuration updates, or user actions.

Parameters​

eventPayload​

NavigationEventPayload

Returns​

Promisable<void>

onLoginSuccess?​

optional onLoginSuccess: OnLoginSuccess

Callback function triggered after successful login.

This function is called when a user successfully authenticates in login or password recovery embeds. It receives the user data object containing authentication details and profile information.

productGroupId?​

optional productGroupId: string

ID of the product group to display in product listings.

When provided, the product list will only show products from the specified product group rather than the full catalog.

sceneShortCode?​

optional sceneShortCode: string

Scene shortcode for modular products.

For modular configurators, this identifies a specific saved scene arrangement that should be loaded. This allows restoring a previously created multi-product configuration.

theme?​

optional theme: Partial<EmbedTheme>

Visual theme configuration.

Controls the visual appearance of the embed, including colors, dimensions, and styling options to match your brand and website design.

uiConfig?​

optional uiConfig: Partial<UiVisibilityConfig>

UI visibility configuration.

Controls which UI elements are visible in the configurator interface. This can be used to hide specific features or simplify the interface.

variant?​

optional variant: string

Variant mode for the embed.

Controls specific behavior modes for the selected embed type. For configurators, options include:

  • 'standard': Full configurator with all features
  • 'preview': Special mode that allows viewing inactive products
  • 'selector': Replaces summary screen with a callback function
  • 'iframe': Limited version for embedding in iframes
  • 'configuratorOnly': Shows just the configurator without additional UI

variantCode?​

optional variantCode: string

Product variant code to load in configurator embeds.

Identifies which specific product should be loaded when rendering a configurator. For standard products, this is the product's prefix code. For modular products with a saved scene, this should be the base product's prefix.

withBackButton?​

optional withBackButton: boolean

Displays a back button in the configurator header.

When true, a back button appears in the header allowing users to navigate to previous screens or exit the configurator.

withModal?​

optional withModal: boolean

Displays the embed in a modal overlay.

When true, the embed appears in a modal dialog rather than inline on the page. This creates a focused experience that temporarily overlays the main content.