Skip to main content

Enumeration: EmbedType

Defines the various types of embeds that can be rendered using the mount method.

Each embed type represents a specific UI component that serves a distinct purpose within the Mimeeq platform, from product configuration to user authentication.

Enumeration Members​

AR​

AR: "AR"

Augmented Reality viewer for products.

This embed type renders an interface for viewing products in augmented reality, allowing users to place virtual products in their real-world environment using their device's camera. It supports various AR features like scale adjustment and environment detection.

Use this embed type to provide immersive product visualization experiences that help users better understand product dimensions and appearance in context.

Required parameters:

  • arShortCode: Short code for the AR model to display

Optional parameters:

  • allowScaling: When true, allows users to adjust the scale of the AR model
  • incompatible: When true, shows a view for incompatible devices

BASKET​

BASKET: "BASKET"

Mimeeq shopping basket interface.

This embed type renders a complete shopping cart interface showing all items added to the cart, with totals, quantities, and product details. It provides functionality to manage cart items, view pricing, and proceed to checkout.

Use this embed type to create a complete shopping cart experience for users.

BASKET_PREVIEW​

BASKET_PREVIEW: "BASKET_PREVIEW"

Mimeeq basket preview for quick cart review.

This embed type renders a lightweight preview of the shopping cart, typically showing a summary of items and totals without the full cart management interface.

Use this embed type for mini-cart previews or quick cart status indicators.

Optional parameters:

  • cartReferenceCode: ID or reference code for basket content to preview

CONFIGURATOR​

CONFIGURATOR: "CONFIGURATOR"

Standard product configurator for non-modular products.

This embed type renders a complete product configuration interface that allows users to customize standard (non-modular) products by selecting options, colors, materials, and other parameters. It includes a 3D or 2D visualization of the product, option panels, and summary/pricing information.

Use this embed type when you need to let users configure individual products with pre-defined customization options.

Required configuration parameters:

  • variantCode: The product variant code to load

FAVOURITES_ONLY​

FAVOURITES_ONLY: "FAVOURITES_ONLY"

Favorites list for authenticated users.

This embed type renders a list of saved product configurations and scenes that the user has previously saved to their favorites. It provides a way for users to access and manage their saved configurations.

Use this embed type to provide authenticated users with access to their saved items. This embed type requires user authentication to function properly.

Optional parameters:

  • favouritePath: Path to a specific favorites collection to display initially

FORGOT_PASSWORD​

FORGOT_PASSWORD: "FORGOT_PASSWORD"

Forgot Password modal for account recovery.

This embed type renders a password recovery flow that allows users to reset their password using email verification. It guides users through requesting a reset code, entering the code, and creating a new password.

Use this embed type to provide users with a way to regain access to their accounts if they've forgotten their passwords.

Required configuration parameters:

  • onLoginSuccess: Callback function that receives the authenticated user data after reset

LOGIN​

LOGIN: "LOGIN"

Login modal for user authentication.

This embed type renders a login form allowing users to authenticate with their Mimeeq credentials. It handles the complete authentication flow, including error handling and success redirection.

Use this embed type when you need to provide users with a way to log in to access account-specific features like saved configurations or pricing.

Required configuration parameters:

  • onLoginSuccess: Callback function that receives the authenticated user data

MODULAR​

MODULAR: "MODULAR"

Modular product configurator for complex, multi-component products.

This embed type renders an advanced configuration interface for modular products, allowing users to add, remove, and configure multiple interconnected components. It provides a 3D workspace with snapping points, component selection, and the ability to build complex product assemblies.

Use this embed type for products that consist of multiple components or elements that can be combined in various ways (e.g., modular furniture systems, kitchen cabinets).

Required configuration parameters:

  • variantCode: The modular product variant code to load

Optional parameters:

  • sceneShortCode: Code to load a specific saved scene
  • finishScreen: When true, opens to element list rather than 3D scene on load

PRODUCT_LIST​

PRODUCT_LIST: "PRODUCT_LIST"

Product list browser with category navigation.

This embed type renders a browsable catalog of products, organized by categories. Users can browse products, filter by different criteria, and select products to configure. For authenticated users, it may also provide access to saved favorites.

Use this embed type to create a product catalog or storefront interface where users can discover and select products before configuration.

Optional parameters:

  • categoryPath: Path to a specific category to display initially
  • productGroupId: ID of a specific product group to display
  • manualSort: When true, products are sorted according to customer-defined order

USER_PROFILE​

USER_PROFILE: "USER_PROFILE"

User Profile modal for account management.

This embed type renders an interface that displays the current user's profile information and provides options to update account details, change passwords, and manage preferences. It is only accessible to authenticated users.

Use this embed type to allow users to view and manage their account information within your application.