Skip to main content

Interface: MimeeqEventMap

Maps Mimeeq event names to their payload types.

This interface provides type-safe event handling by associating each event name string with its corresponding payload type. Use it with helper utilities to get full IntelliSense support when adding event listeners.

Events with undefined payloads are notification signals — listen for them to trigger actions, but event.detail will not contain structured data.

Example​

// Type-safe event listener helper
function onMimeeqEvent<K extends keyof MimeeqEventMap>(
  eventName: K,
  handler: (payload: MimeeqEventMap[K]) => void,
): void {
  document.addEventListener(eventName, ((event: CustomEvent) => {
    handler(event.detail);
  }) as EventListener);
}

// Usage — payload is fully typed as SelectOptionEventPayload
onMimeeqEvent('mimeeq-select-option', (payload) => {
  console.log(payload.variantCode, payload.groupName);
});

// Usage — no payload expected
onMimeeqEvent('mimeeq-app-loaded', () => {
  console.log('Configurator library ready');
});

Properties​

mimeeq-2d-product-initialized​

mimeeq-2d-product-initialized: undefined

2D product fully loaded and all image layers ready.

mimeeq-3d-after-export-image​

mimeeq-3d-after-export-image: undefined

Image exported and saved.

mimeeq-3d-after-export-scene​

mimeeq-3d-after-export-scene: undefined

3D model exported and saved.

mimeeq-3d-before-export-image​

mimeeq-3d-before-export-image: undefined

Image export started.

mimeeq-3d-before-export-scene​

mimeeq-3d-before-export-scene: undefined

3D model export started.

mimeeq-3d-close-full-screen​

mimeeq-3d-close-full-screen: undefined

Left fullscreen view.

mimeeq-3d-hide-dimensions​

mimeeq-3d-hide-dimensions: undefined

Dimensions overlay hidden on the 3D scene.

mimeeq-3d-open-full-screen​

mimeeq-3d-open-full-screen: undefined

Entered fullscreen view.

mimeeq-3d-product-initialized​

mimeeq-3d-product-initialized: undefined

3D product fully initialized and ready for interaction.

mimeeq-3d-show-dimensions​

mimeeq-3d-show-dimensions: undefined

Dimensions overlay shown on the 3D scene.

mimeeq-3d-zoom-out-scene​

mimeeq-3d-zoom-out-scene: undefined

Zoom Out button clicked.

mimeeq-activate-matching-options​

mimeeq-activate-matching-options: DeactivateMatchingOptionsEventPayload

Match Options toggled (activated). Same payload as deactivate — state reflects the new state.

mimeeq-add-to-cart​

mimeeq-add-to-cart: FinishEventPayload

Add to Cart button clicked (basket mode).

mimeeq-app-loaded​

mimeeq-app-loaded: undefined

Configurator library loaded and ready.

mimeeq-app-template-error​

mimeeq-app-template-error: AppTemplateErrorEventPayload

Error loading embed template (file not found or parse failure).

mimeeq-app-url-change​

mimeeq-app-url-change: FinishEventPayload

URL updated after finish action.

mimeeq-ar-get-back-to-configuration​

mimeeq-ar-get-back-to-configuration: ArGoBackEventPayload

Edit button clicked on AR landing page.

mimeeq-auth-loaded​

mimeeq-auth-loaded: undefined

Authentication library loaded.

mimeeq-basket-created​

mimeeq-basket-created: BasketCreatedEventPayload

New basket created.

mimeeq-basket-item-added​

mimeeq-basket-item-added: BasketItemAddedEventPayload

Item added to basket.

mimeeq-basket-submitted​

mimeeq-basket-submitted: BasketSubmittedEventPayload

Basket submitted as order/RFQ.

mimeeq-basket-updated​

mimeeq-basket-updated: BasketUpdatedEventPayload

Basket contents or totals updated.

mimeeq-before-add-to-cart​

mimeeq-before-add-to-cart: BeforeAddToCartEventPayload

Add to Cart action started, before validation and payload preparation.

mimeeq-change-quantity​

mimeeq-change-quantity: ChangeQuantityEventPayload

Quantity changed in the configurator.

mimeeq-clear-filters​

mimeeq-clear-filters: undefined

Clear Filters button clicked.

mimeeq-click-hotspot​

mimeeq-click-hotspot: ClickHotspotEventPayload

Hotspot clicked in the 3D scene.

mimeeq-close-favourites​

mimeeq-close-favourites: undefined

Favourites panel closed.

mimeeq-configurator-clear-history​

mimeeq-configurator-clear-history: undefined

Close button clicked in modal mode, clearing history.

mimeeq-configurator-closed​

mimeeq-configurator-closed: undefined

Configurator modal closed (legacy embed only).

mimeeq-configurator-go-back​

mimeeq-configurator-go-back: undefined

Back arrow clicked in configurator.

mimeeq-deactivate-matching-options​

mimeeq-deactivate-matching-options: DeactivateMatchingOptionsEventPayload

Match Options toggled.

mimeeq-download-file​

mimeeq-download-file: DownloadFileEventPayload

File downloaded from gallery or files tab.

mimeeq-embed-unmounted​

mimeeq-embed-unmounted: undefined

Embed web component removed from DOM.

mimeeq-enter-forgot-password​

mimeeq-enter-forgot-password: undefined

Forgot Password link clicked.

mimeeq-enter-login​

mimeeq-enter-login: undefined

Login form shown.

mimeeq-enter-product​

mimeeq-enter-product: ProductPrefixEventPayload

Product configurator opened.

mimeeq-enter-profile​

mimeeq-enter-profile: undefined

User profile opened.

mimeeq-enter-sign-up​

mimeeq-enter-sign-up: undefined

Sign Up form shown.

mimeeq-favourites-add-collection​

mimeeq-favourites-add-collection: FavouritesCollectionEventPayload

Favourites collection created.

mimeeq-favourites-add-product​

mimeeq-favourites-add-product: ProductPrefixEventPayload

Product added to favourites.

mimeeq-favourites-copy-to-collection​

mimeeq-favourites-copy-to-collection: FavouritesCollectionItemsEventPayload

Items copied to another favourites collection.

mimeeq-favourites-delete-from-collection​

mimeeq-favourites-delete-from-collection: FavouritesDeleteFromCollectionEventPayload

Items removed from a favourites collection.

mimeeq-favourites-move-to-collection​

mimeeq-favourites-move-to-collection: FavouritesCollectionItemsEventPayload

Items moved to another favourites collection.

mimeeq-favourites-remove-collection​

mimeeq-favourites-remove-collection: undefined

Favourites collection(s) deleted.

mimeeq-favourites-remove-product​

mimeeq-favourites-remove-product: ProductPrefixEventPayload

Product removed from favourites.

mimeeq-favourites-update-collection​

mimeeq-favourites-update-collection: FavouritesCollectionEventPayload

Favourites collection updated.

mimeeq-forgot-password-closed​

mimeeq-forgot-password-closed: undefined

Forgot Password modal dismissed.

mimeeq-generate-ar-short-code​

mimeeq-generate-ar-short-code: GenerateArShortCodeEventPayload

AR short code generated.

mimeeq-history-go-back​

mimeeq-history-go-back: HistoryItem

History undo (back) clicked.

mimeeq-history-go-forward​

mimeeq-history-go-forward: HistoryItem

History redo (forward) clicked.

mimeeq-history-reset​

mimeeq-history-reset: undefined

History reset clicked.

mimeeq-leave-forgot-password​

mimeeq-leave-forgot-password: undefined

Forgot Password form closed.

mimeeq-leave-login​

mimeeq-leave-login: undefined

Login form closed.

mimeeq-leave-product​

mimeeq-leave-product: ProductPrefixEventPayload

Product configurator closed.

mimeeq-leave-profile​

mimeeq-leave-profile: undefined

User profile closed.

mimeeq-leave-sign-up​

mimeeq-leave-sign-up: undefined

Sign Up form closed.

mimeeq-login-closed​

mimeeq-login-closed: undefined

Login modal dismissed.

mimeeq-login-success​

mimeeq-login-success: UserData

Login successful.

mimeeq-logout-success​

mimeeq-logout-success: undefined

Logout completed.

mimeeq-modular-abort-action​

mimeeq-modular-abort-action: undefined

Currently active modular action aborted.

mimeeq-modular-add-product-to-scene​

mimeeq-modular-add-product-to-scene: ModularProductSceneEventPayload

Product added to the modular scene.

mimeeq-modular-clear-scene​

mimeeq-modular-clear-scene: undefined

Scene cleared.

mimeeq-modular-clone-product​

mimeeq-modular-clone-product: undefined

Product cloned on the scene.

mimeeq-modular-close-my-scenes​

mimeeq-modular-close-my-scenes: undefined

My Scenes view closed.

mimeeq-modular-close-select-scene-modal​

mimeeq-modular-close-select-scene-modal: undefined

Load Scene modal closed.

mimeeq-modular-close-summary​

mimeeq-modular-close-summary: undefined

Summary closed in modular.

mimeeq-modular-close-warning​

mimeeq-modular-close-warning: undefined

Warning modal closed in modular.

mimeeq-modular-closed​

mimeeq-modular-closed: undefined

Modular modal closed (legacy embed only).

mimeeq-modular-create-new-scene​

mimeeq-modular-create-new-scene: ModularLoadSceneEventPayload

New short code assigned for scene (after New Scene, Clear Scene, or entering a scene).

mimeeq-modular-enter-product​

mimeeq-modular-enter-product: undefined

Modular product entered.

mimeeq-modular-flip-product​

mimeeq-modular-flip-product: undefined

Product flipped on the scene.

mimeeq-modular-hide-grid​

mimeeq-modular-hide-grid: undefined

Grid overlay hidden.

mimeeq-modular-history-go-back​

mimeeq-modular-history-go-back: undefined

Modular history undo (back) clicked.

mimeeq-modular-history-go-forward​

mimeeq-modular-history-go-forward: undefined

Modular history redo (forward) clicked.

mimeeq-modular-insert-product-to-scene​

mimeeq-modular-insert-product-to-scene: ModularProductSceneEventPayload

Product inserted between elements on the scene.

mimeeq-modular-leave-product​

mimeeq-modular-leave-product: undefined

Modular product left (navigated away).

mimeeq-modular-load-scene​

mimeeq-modular-load-scene: ModularLoadSceneEventPayload

Saved scene or default configuration loaded.

mimeeq-modular-load-scene-success​

mimeeq-modular-load-scene-success: undefined

Saved scene loaded successfully.

mimeeq-modular-move-product​

mimeeq-modular-move-product: ModularProductSceneEventPayload

Product moved on the scene.

mimeeq-modular-open-my-scenes​

mimeeq-modular-open-my-scenes: undefined

My Scenes view opened.

mimeeq-modular-open-summary​

mimeeq-modular-open-summary: undefined

Finish button clicked in modular (summary opened).

mimeeq-modular-open-warning​

mimeeq-modular-open-warning: undefined

Scene validation warning modal opened in modular.

mimeeq-modular-product-replaced​

mimeeq-modular-product-replaced: ModularProductSceneEventPayload

Product replaced with another on the scene.

mimeeq-modular-remove-product​

mimeeq-modular-remove-product: undefined

Product removed from the scene.

mimeeq-modular-save-scene​

mimeeq-modular-save-scene: ModularSaveSceneEventPayload

Scene saved or updated as favourite.

mimeeq-modular-select-option​

mimeeq-modular-select-option: ModularSelectOptionEventPayload

Option selected for a single product in modular.

mimeeq-modular-select-option-multiple​

mimeeq-modular-select-option-multiple: ModularSelectOptionMultipleEventPayload

Option applied to multiple products in modular.

mimeeq-modular-select-product-to-add​

mimeeq-modular-select-product-to-add: ModularSelectProductToAddEventPayload

Product to add chosen from product list modal.

mimeeq-modular-set-clone​

mimeeq-modular-set-clone: undefined

Clone button clicked in modular toolbar.

mimeeq-modular-set-copy-styles​

mimeeq-modular-set-copy-styles: undefined

Copy Styles button clicked in modular toolbar.

mimeeq-modular-set-move​

mimeeq-modular-set-move: undefined

Move button clicked in modular toolbar.

mimeeq-modular-set-replace​

mimeeq-modular-set-replace: undefined

Replace button clicked in modular toolbar.

mimeeq-modular-set-slide​

mimeeq-modular-set-slide: undefined

Slide button clicked in modular toolbar.

mimeeq-modular-show-grid​

mimeeq-modular-show-grid: undefined

Grid overlay activated.

mimeeq-modular-unselect-all​

mimeeq-modular-unselect-all: undefined

All products deselected on the scene.

mimeeq-open-favourites​

mimeeq-open-favourites: undefined

Favourites panel opened from the product list.

mimeeq-open-option-panel​

mimeeq-open-option-panel: undefined

Option panel opened on mobile.

mimeeq-open-related-product: OpenRelatedProductEventPayload

Related product clicked.

mimeeq-pdf-generate-done​

mimeeq-pdf-generate-done: undefined

PDF generation completed.

mimeeq-pdf-generate-start​

mimeeq-pdf-generate-start: undefined

PDF generation started.

mimeeq-price-change​

mimeeq-price-change: PriceChangeEventPayload

About to fetch updated price (standard products only).

mimeeq-product-list-initialized​

mimeeq-product-list-initialized: undefined

Product list loaded from database.

mimeeq-product-list-select-product​

mimeeq-product-list-select-product: ProductListSelectProductEventPayload

Product selected from product list.

mimeeq-profile-closed​

mimeeq-profile-closed: undefined

User Profile modal dismissed.

mimeeq-resend-signup-confirm-code​

mimeeq-resend-signup-confirm-code: ResendSignupConfirmCodeEventPayload

Signup verification code resent.

mimeeq-scene-validation​

mimeeq-scene-validation: SceneValidationEventPayload

Modular scene validation completed before a Finish or Add to Cart action.

mimeeq-select-company​

mimeeq-select-company: SelectCompanyEventPayload

Company changed in price selector.

mimeeq-select-favourites-collection​

mimeeq-select-favourites-collection: SelectFavouritesCollectionEventPayload

Favourites collection selected from menu.

mimeeq-select-filters​

mimeeq-select-filters: SelectFiltersEventPayload

Filters changed.

mimeeq-select-option​

mimeeq-select-option: SelectOptionEventPayload

Option selected in the option panel.

mimeeq-select-popular-variant: SelectPopularVariantEventPayload

Popular configuration variant selected.

mimeeq-select-price-type​

mimeeq-select-price-type: SelectPriceTypeEventPayload

Price type changed in price selector.

mimeeq-select-product​

mimeeq-select-product: FinishEventPayload

Select button clicked (selector variant).

mimeeq-select-tab​

mimeeq-select-tab: SelectTabEventPayload

Tab changed in the configurator.

mimeeq-show-export-pdf-modal​

mimeeq-show-export-pdf-modal: undefined

Generate PDF modal opened.

mimeeq-show-summary​

mimeeq-show-summary: FinishEventPayload

Finish button clicked (non-basket mode).

mimeeq-sign-up-success​

mimeeq-sign-up-success: UserData

Sign Up successful.

mimeeq-tree-unmounted​

mimeeq-tree-unmounted: TreeUnmountedEventPayload

Embed unmounted from DOM, with type identifier (legacy embed only).

mimeeq-user-deleted​

mimeeq-user-deleted: undefined

Tier 2 user deleted own account.

mimeeq-user-signed-in​

mimeeq-user-signed-in: UserData

User session established after login.

mimeeq-user-signed-out​

mimeeq-user-signed-out: undefined

User session destroyed after logout.

mimeeq-user-updated​

mimeeq-user-updated: undefined

User profile data updated.

mimeeq-webgl-not-supported​

mimeeq-webgl-not-supported: undefined

WebGL not supported and user attempted to load a 3D product.

mmq-action-flash-highlight-block​

mmq-action-flash-highlight-block: string

Scrolled to option block after Scroll to Block mesh click. Payload is the affected block ID.

mmq-action-highlight-group-off​

mmq-action-highlight-group-off: string

Left hover over mesh with Highlight Group behavior. Payload is the affected block ID.

mmq-action-highlight-group-on​

mmq-action-highlight-group-on: string

Hover over mesh with Highlight Group behavior. Payload is the affected block ID.

mmq-action-open-group​

mmq-action-open-group: string

Clicked mesh with Open Group action. Payload is the affected block ID.

mmq-action-scroll-to-block​

mmq-action-scroll-to-block: string

Clicked mesh with Scroll to Block action. Payload is the affected block ID.

mmq-webgl-support-modal-close​

mmq-webgl-support-modal-close: undefined

No WebGL support modal dismissed.