Interface: NavigationEventPayload
Payload data for navigation events in the configurator.
This interface defines the data structure for navigation-related events that occur within the Mimeeq configurator. It contains information about the navigation action, target destinations, product identifiers, and other contextual data that helps track and respond to user navigation patterns.
Navigation events are used to synchronize the configurator state with external systems, update URLs, track user journeys, or trigger additional actions when users navigate between different parts of the configuration experience.
Properties
action?
optionalaction:string
Type of navigation action being performed.
Examples include 'open-product', 'add-to-cart', 'show-favourites', etc.
allowScaling?
optionalallowScaling:boolean
Indicates whether scaling is allowed for the current view.
Primarily used in AR modes to control whether users can resize the model.
arShortCode?
optionalarShortCode:string
AR short code for the current configuration.
A specific code used to load the model in AR experiences.
cartRef?
optionalcartRef:string
Shopping cart reference identifier.
Used when navigating to or from cart-related views.
category?
optionalcategory:string
Category identifier for product list navigation.
Used when navigating within product categories or filtering products.
embedInstanceId?
optionalembedInstanceId:string
ID of the embed instance that triggered this event.
Useful for identifying which configurator instance originated the event when multiple instances exist on the same page.
favourite?
optionalfavourite:string
Favourite collection identifier.
Used when navigating within saved favourite configurations.
favouriteCollection?
optionalfavouriteCollection:string
Favourite collection to load or display.
Used when navigating between different favourite collections.
hash?
optionalhash:string
Navigation hash (fragment identifier).
Used for deep linking or maintaining state across page reloads.
incompatible?
optionalincompatible:boolean
Indicates whether the configuration is incompatible.
Used primarily for AR compatibility checking.
isActive?
optionalisActive:boolean
Deprecated
isFavourite?
optionalisFavourite:boolean
Indicates whether the navigation is to a favourite configuration.
When true, the user is accessing a saved favourite configuration.
isModular?
optionalisModular:boolean
Indicates whether the current product is a modular product.
When true, the configurator is dealing with a modular product that allows arranging multiple components in a scene, rather than a standard product.
quotationId?
optionalquotationId:string
Quotation ID for the current configuration.
Used when generating or accessing quotations.
searchString?
optionalsearchString:string
Search text when navigating via search functionality.
Contains the query string used to search for products.
shortCode?
optionalshortCode:string
Short code for the current configuration.
This unique identifier represents a specific product configuration and can be used to restore that configuration in the future.
tab?
optionaltab:string
Identifier for the tab being navigated to.
Used when navigating between different tabs within the product view.
target?
optionaltarget:string
Target destination for the navigation.
Specifies where or how the navigation should be performed (e.g., '_blank').
variantCode?
optionalvariantCode:string
Variant code for the current product.
This identifies the specific product variant being configured.