Interface: MountConfiguratorPayload
Configuration for mounting a product configurator embed.
This interface extends the core embed configuration with properties specific to product configuration experiences. It controls which product is loaded, how it's displayed, and what features are available to the user during the configuration process.
Product configurators allow users to customize products by selecting options, visualizing changes in real-time, and saving or sharing their configurations.
Extends
Properties
appUrl?
optionalappUrl:string
Base URL for the application.
Used primarily for AR experiences to provide a return path. This should be the URL to the main application hosting the embed.
baseURL?
optionalbaseURL:string
Base URL for API requests.
This specifies the endpoint for all API communications from the embed. If not provided, the system will use the default API URL from the embed environment.
Inherited from
CDNPath?
optionalCDNPath:string
Path to the CDN for static assets.
This URL is used to load images, 3D models, and other static resources required by the configurator. If not provided, the system will use the default CDN path from the embed environment.
Inherited from
customerId
customerId:
string
Identifier for the customer account.
This specifies which customer's products and configurations will be available in the embed. Each customer has their own isolated data and settings.
Inherited from
EmbedPayloadPartial.customerId
elementId?
optionalelementId:string
Deprecated
Use uid with data-mimeeq-short-code attributes instead
ID of HTML element in which to mount the embed
Inherited from
finishScreen?
optionalfinishScreen:boolean
Shows the finish screen 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?
optionalhash:string
Initial tab to display when the 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.
isFavourite?
optionalisFavourite:boolean
Enables favorites functionality.
When true, users can save and load favorite configurations. This requires authentication unless public favorites are enabled.
isModular?
optionalisModular:boolean
Indicates whether to load a modular configurator.
When true, the system will load a modular configurator that allows arranging multiple products in a scene. When false or omitted, a standard product configurator is loaded for single-product configuration.
legacy?
optionallegacy:boolean
Enables legacy compatibility mode for standard configurators.
When true, uses older default values and behaviors for backward compatibility. This should only be used when integrating with older implementations.
locale
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'.
Inherited from
modularLegacy?
optionalmodularLegacy:boolean
Enables legacy compatibility mode for modular configurators.
When true, uses older default values and behaviors for backward compatibility specifically in modular mode. This should only be used when integrating with older implementations.
onEventDispatch?
optionalonEventDispatch:EventDispatchCallback<any>
Callback function for handling events from the embed.
This function is called whenever a significant event occurs within the configurator, such as option selection, configuration changes, or user actions. It allows the hosting application to respond to these events.
Inherited from
EmbedPayloadPartial.onEventDispatch
renderOnMount?
optionalrenderOnMount:boolean
Controls whether the embed renders immediately.
When true, the configurator will render as soon as it's mounted. When false, rendering must be triggered manually via the API. This is useful for scenarios where preparation is needed before display.
shortCode?
optionalshortCode:string
Scene shortcode for modular products.
For modular products, this identifies a specific saved scene arrangement that should be loaded. This allows restoring a previously created multi-product configuration.
uid
uid:
string
Unique identifier for this embed instance.
This ID is used to identify a specific embed configuration and is typically the shortcode for the embed. The system will mount the embed into an HTML element with a data-mimeeq-shortcode attribute matching this value.
Each embed on a page should have a unique UID to prevent conflicts.
Inherited from
variant?
optionalvariant:string
Configurator operating mode.
Controls the configurator's behavior and available features:
- '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 elements
variantCode
variantCode:
string
Product variant code to load in the configurator.
This code identifies which specific product should be loaded when the configurator initializes. 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?
optionalwithBackButton: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.
withWatcher?
optionalwithWatcher:boolean
Enables sandbox logic for development and testing.
When true, the embed runs in a sandboxed mode with additional monitoring and development features. This should generally be false in production.