Embed Template Settings Guide
Content
- Name and ID
- Preview Settings
- Layout Settings
- Modal Settings
- Product List and Groups
- E-commerce
- Interface Elements
- Dimensions
- PDF Settings
- Theme
- Custom Assets
- Custom CSS
- Custom JavaScript
Overview
Embed templates are the control center for your embeds. They allow you to define consistent styling, behavior, and settings that can be applied across multiple embeds. Each template has a unique ID that you reference when generating embed codes, allowing centralized control over multiple embeds across your website.
Templates are created and managed through a user-friendly GUI in the Mimeeq admin panel. You don't need to work with JSON directly - the admin panel provides intuitive controls for all settings.
This guide provides a detailed breakdown of all available Embed Template settings, helping you understand what each option does and when to use it. Whether you’re setting up a simple product experience or configuring advanced behaviour, these settings allow you to tailor the configurator to your needs.
Why Multiple Templates?
Imagine you're running an e-commerce furniture company. You'll need different embed experiences for different parts of your business:
Template 1: "Product Page with Pricing" This is your main selling template. When customers visit your product pages, they see the full configurator with all customization options, live pricing updates, and an add-to-cart button. This template includes everything needed for a complete shopping experience.
Template 2: "Canvas Only View" Sometimes you just want to showcase your products without all the controls. This template displays only the 3D product preview - perfect for your homepage hero banner, blog posts about design trends, or social media embeds. Visitors can rotate and view the product but won't see prices or configuration options, keeping the focus on the visual appeal.
Template 3: "B2B Partner Portal" Your business partners need a different experience. This template is designed for your dealer network where they can configure products for their clients, save multiple configurations to lists, and request bulk quotes instead of seeing retail prices. It requires login authentication and shows partner-specific pricing tiers.
Creating a New Embed Template
- Navigate to Settings → Data → Embed Templates in Mimeeq Admin
- Click "Create New Template"
- Assign a template name and ID
- Configure your settings (detailed below)
- Save and use the template ID in your embed code
Template Configuration Settings
Name and ID
Settings | Description |
|---|---|
Name | Internal identifier for the Embedded Template (e.g., "Shopify Embedded Template USD" or "B2B Portal with Basket") |
ID | Auto-generated unique identifier. It can be changed manually, but doing so may break existing integrations if the template is already in use |
Preview Settings
This section allows you to configure how the configurator behaves in preview and on your live embed — including language, pricing, and loading behavior.
Settings | Description |
|---|---|
Language | Dropdown selector for all available languages in your account |
Price List Group | Assigns a specific price list group to the Embedded Template |
URL Navigation | When enabled, the configurator state is saved to the page URL. This lets users refresh, share, or return to a page without losing their configuration. It also auto-opens the configurator when a variantCode is present in the URL (even if "Render at page load" is off) |
Render at Page Load | When enabled, the configurator renders immediately on page load. Turn off to delay rendering until triggered by a user action (e.g. a "Configure" button). If you're using modal rendering, we recommend keeping this off, as the modal is typically opened by a button click rather than on page load |
Layout Settings
This section controls how the configurator is displayed on your website.
Settings | Description |
|---|---|
Render list and groups in modal | Opens the product list and/or product group in an overlay modal instead of inline on the page |
Render modular configurator in modal | Opens the modular configurator in an overlay modal. Recommended ON |
Render standard configurator in modal | Opens the standard product configurator in an overlay modal instead of inline on the page |
Use default page font | Inherits the font from the host webpage instead of Mimeeq's default font |
Adjust to container | Makes the embed fill 100% of its parent container. When off, applies a max-width of ~1600px |
Modal Settings
Define the size and layout of the modal when modal display options are enabled (for Product List and Groups, Modular and Standard Configurator).
Settings | Description |
|---|---|
Width Units | Unit used for modal width (px, %, vw, etc.) |
Width Value | Width of the modal (for example, 90%) |
Height Units | Unit used for modal height (px, %, vw, etc.) |
Height Value | Height of the modal (for example, 90%) |
Scrollbar Placement | Controls where the scroll bar appears in modals (Inside or Outside of the modal) |
Custom Class Name | Adds a CSS class to the modal element, allowing custom styles to be applied from the host page |
Product List and Groups
Configure preview for Product List and Product Group embeds.
Settings | Description |
|---|---|
Show menu controls | Displays a dynamic menu with search, category and tag filters, A–Z sorting, and a tile size toggle. |
Show favourites | Allows logged-in users to save and revisit favourite products in the standard configurator and saved scenes in the modular configurator. |
E-commerce
This section controls pricing behaviour and basket functionality in the configurator.
Settings | Description |
|---|---|
Use Custom Pricing | Uses pricing data from your external system instead of Mimeeq price lists. |
Basket Support | Enables basket functionality. When turned on, users can collect and submit their configuration using the built-in Add to Cart button and related logic. |
If you want to use basket functionality, go to the Mimeeq Basket System Guide, this guide covers all advanced configuration options, including custom pricing, Add to Cart button placement, integration types, and URL settings.
Interface Elements
Customise configurator interface by selecting UI elements you want to be shown on the screen.
Base UI
Settings | Description |
|---|---|
Use Mimeeq UI | Turn off to replace default Mimeeq configurator interface with a fully custom UI. |
Quick Icons
Settings | Description |
|---|---|
Show Add to Favorites | Shows the Add to Favorites icon |
Show Export Image | Shows image export icon |
Show Full Screen | Shows the full-screen icon |
Show Model Export | Shows 3D model export icon |
Show PDF Generation | Shows PDF export icon |
Show Redo | Shows the redo action icon |
Show Reset | Shows the reset configuration icon |
Show Undo | Shows the undo action icon |
Show Warning 3D Message | Shows icon with a 3D warning message |
Show Zoom All | Shows zoom all icon (Reset camera position to a default view) |
Show Zoom Controls | Shows zoom control icons (Zoom in and Zoom out) |
Canvas
Settings | Description |
|---|---|
Show AR Button | Shows augmented reality viewing option |
Show Collection Name | Shows collection name on the canvas |
Show Drag Information | Shows drag interaction tooltip on the canvas (on the first load) |
Show Hotspots | Shows hotspot indicators on the canvas |
Show Product Name | Shows product name on the canvas |
Option Panel
Settings | Description |
|---|---|
Show Finish Button | Show the finish button in the option panel footer |
Show Option Panel | Shows configuration panel with options |
Show Price | Shows price in the option panel footer |
Show Quantity | Shows quantity selector in the option panel footer |
Show VAT Information | Shows VAT information next to price (for example, Including VAT) |
Finish Screen
Settings | Description |
|---|---|
Show Delivery Information | Shows delivery information on the summary screen |
Show Finish Screen | Enables summary screen |
Show Generate PDF Button | Shows PDF generation button on summary screen |
Show Share Options | Shows sharing options from the summary screen |
Tabs and Related Products
Settings | Description |
|---|---|
Show Tabs | Shows tab navigation under the 3D canvas |
Show Related Products | Show related product suggestions under the 3D canvas |
Modular Elements
Settings | Description |
|---|---|
Show Copy Link | Shows Copy Link icon in the modular header |
Show Modular Warnings | Shows warnings modals for modular product configurations |
Dimensions
This section controls how dimension lines are displayed and how users interact with them. To learn more about dimensions, go to our dedicated help article → Dimension Overlay — Setup and Configuration Guide.
Settings | Description |
|---|---|
Allows users to toggle dimensions on/off | Controls the visibility of dimensions on the 3D Canvas. When enabled, dimensions remain permanently visible and the dimension icon is hidden from the canvas, preventing users from toggling it back off. |
Show Dimensions Toggle on Canvas | Shows Dimensions Icon on the 3D Canvas that allows users to toggle dimensions on/off |
Unit Display Mode | Defines how measurement units are presented in the configurator. You can use the default unit from global settings, override it with a specific unit, or allow users to switch between multiple units. |
Unit Display Mode Options:
- Default Unit - Uses global settings
- Override Default Unit - Replaces default unit with another (auto-converted)
- Multi Unit - Allows switching between multiple units directly on the 3D canvas
When Multi Unit is selected, you can specify which units are available for users to choose from directly on the canvas.
Available Units:
- mm, cm, m
- in, ft, ft + in
PDF Settings
PDF generation settings — including branding, product details, pricing visibility, and dimension display on images — are covered in the dedicated guide: PDF export: setup and settings guide.
Theme
Override default visual styling to match your brand colors (if none uses default Theme settings).
Settings | Description |
|---|---|
Button Color Override | Override default button background color |
Button Text Color Override | Override default button text color |
Background Color Override | Override default default color |
Basket Button Color Override | Override default basket button background color |
Option Group Highlight Color Override | Override default group background color |
Option Group Hover Color Override | Override default group hover color |
Opened Group Text Color Override | Override default group text color |
Hover Group Text Color Override | Override default group hover text color |
Custom Assets
Upload and manage custom resources such as CSS or JavaScript. These assets can be used to extend functionality or customize the configurator’s appearance
Custom CSS
Inject custom CSS into the configurator to override styles or fine-tune the appearance beyond what the Theme settings provide. To do that turn on Use Custom CSS and paste it in the field bellow.
Custom JavaScrip
Inject custom JavaScript into the configurator to extend functionality, respond to events, or integrate with third-party scripts. To do that turn on Use Custom JavaScript and paste it in the field bellow. Mimeeq Embeds provide JavaScript events for product selection, configuration changes, add to basket actions, basket submissionsRefer to the Mimeeq JavaScript API documentation for complete event reference.
If you have any questions or need help setting up your embed templates, feel free to reach out to our support team.
Updated on: 19/06/2026
Thank you!