For the complete documentation index, see llms.txt. This page is also available as Markdown.

Embed Template Settings

Configure layout, behaviour, UI elements, and advanced settings for your embed templates.

Embed templates are the control centre for your embeds. Each template has a unique ID you reference when generating embed codes, giving you centralised control over styling, behaviour, and settings across multiple embeds on your website. Templates are created and managed through the Mimeeq admin panel — no JSON editing required.

Why Multiple Templates?

Using multiple templates lets you create different embed experiences for different parts of your website.

Template
Typical use case
Key characteristics

Product Page with Pricing

E-commerce product pages

Full configurator, live pricing, add-to-cart button

Canvas Only View

Homepage banners, blog posts

3D preview only — no controls or pricing

B2B Partner Portal

Dealer networks

Authentication required, partner pricing, quote requests

Creating a New Embed Template

  1. Navigate to Settings → Data → Embed Templates in Mimeeq Admin

  2. Click Create New Template

  3. Assign a template name and ID

  4. Configure your settings (detailed below)

  5. Save and use the template ID in your embed code

Template Configuration Settings

Template Configuration Settings Layout

Name and ID

Setting
Description

Name

Internal identifier for the template (e.g., "Shopify Embedded Template USD" or "B2B Portal with Basket").

ID

Auto-generated unique identifier. Can be changed manually, but doing so may break existing integrations if the template is already in use.

Preview Settings

Configure how the configurator behaves in preview and on your live embed — including language, pricing, and loading behaviour.

Setting
Description

Language

Dropdown selector for all available languages in your account.

Price List Group

Assigns a specific price list group to the embed template.

URL Navigation

When enabled, the configurator state is saved to the page URL. Users can refresh, share, or return to a page without losing their configuration. Also auto-opens the configurator when a variantCode is present in the URL.

Render at Page Load

When enabled, the configurator renders immediately on page load. Disable to delay rendering until triggered by a user action (e.g. a Configure button). If you are using modal rendering, keep this off — the modal is typically opened by a button click rather than on page load.

Layout Settings

Controls how the configurator is displayed on your website.

Setting
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.

Define the size and layout of the modal when modal display options are enabled.

Setting
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 the preview for Product List and Product Group embeds.

Setting
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

Controls pricing behaviour and basket functionality in the configurator.

Setting
Description

Use Custom Pricing

Uses pricing data from your external system instead of Mimeeq price lists.

Basket Support

Enables basket functionality. Users can collect and submit their configuration using the built-in Add to Cart button.

For advanced basket configuration — including custom pricing, button placement, integration types, and URL settings — see the Mimeeq Basket System guide.

Interface Elements

Customise the configurator interface by selecting which UI elements are shown.

Example of hidden interface elements

Base UI

Setting
Description

Use Custom UI

When enabled, replaces the default Mimeeq configurator interface with a fully custom UI. Leave off to use the standard Mimeeq UI.

Quick Icons

Setting
Description

Show Add to Favourites

Shows the Add to Favourites 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 (resets camera to default view).

Show Zoom Controls

Shows zoom control icons (Zoom in and Zoom out).

Canvas

Setting
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 first load).

Show Hotspots

Shows hotspot indicators on the canvas.

Show Product Name

Shows product name on the canvas.

Option Panel

Setting
Description

Show Finish Button

Shows 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

Setting
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

Setting
Description

Show Tabs

Shows tab navigation under the 3D canvas.

Show Related Products

Shows related product suggestions under the 3D canvas.

Modular Elements

Setting
Description

Show Copy Link

Shows Copy Link icon in the modular header.

Show Modular Warnings

Shows warnings modals for modular product configurations.

Dimensions

Controls how dimension lines are displayed, which unit they use and how rounded values are calculated for this embed. For more detail, see Dimension Overlay.

Setting
Description

Show Dimensions Toggle on Canvas

Shows the dimensions icon on the 3D canvas, allowing users to toggle dimensions on or off. On by default.

Show Dimensions on Load

When enabled, dimension lines are visible when the configurator loads. Users can still toggle them on or off. Off by default.

Always Show Dimensions

Dimensions remain permanently visible and the toggle icon is hidden, preventing users from turning them off. Enabling this disables both Show Dimensions on Load and Show Dimensions Toggle on Canvas.

Font Family

Sets the font used for dimension pill labels. You can select any Google Font or upload a custom font. See How to Upload and Use Custom Fonts.

Unit Display Mode

Defines how measurement units are presented. Use the default global setting, override with a specific unit, or allow users to switch between units.

Rounding Method Override

Replaces the rounding method from the product rule for this embed. Options: Use product rule (default), Round to nearest, Round up, Round down.

Rounding Value

Replaces the step size from the product rule for this embed, for example 10 to round to 10 cm steps. Shown only when Rounding Method Override is not Use product rule. Enter it in the product's default dimension unit. It is converted automatically when the display unit changes.

Unit Display Mode Options:

  • Default Unit — uses global settings

  • Override Default Unit — replaces the default unit with another (auto-converted)

  • Multi Unit — allows switching between multiple units directly on the 3D canvas

Example of visible dimensions

When Multi Unit is selected, specify which units are available for users to choose from on the canvas.

Available Units: mm, cm, m, in, ft, ft + in

Multi-unit selector on the 3D canvas

Rounding Method Override

Use Rounding Method Override to show dimensions differently in each market without changing your products. Each market usually has its own embed template, so you set the rounding once per template.

#
Option
What it does

1

Use product rule

Keeps the method and step size from each product's rounding rule. This is the default, so existing templates are unchanged.

2

Round to nearest

Rounds to the closest step, up or down.

3

Round up

Always rounds to the next step. The displayed value is never smaller than the measured size.

4

Round down

Always rounds to the previous step. The displayed value is never larger than the measured size.

When you choose options 2–4, the Rounding Value field appears. Enter the step size this embed should use. It replaces the step size set on the product rule.

Which setting wins

  1. If Rounding Method Override is set to anything other than Use product rule, the embed's method and Rounding Value are used.

  2. Otherwise, the Rounding method and Rounding value from the product's Override Dimensions or Round Dimensions rule are used.

  3. If the product rule has no rounding method, Round to nearest is used. Rules created before this setting existed behave the same as before.

Switching units on the canvas (for example, from cm to in with Multi Unit) changes only the displayed unit. The rounding method stays the same.

How each method changes the result

Product rule rounding width to 10 cm steps. The embed override uses Rounding Value 10:

#
Measured width
Round to nearest
Round up
Round down

1

201.3 cm

200 cm

210 cm

200 cm

2

206.2 cm

210 cm

210 cm

200 cm

If the embed sets Rounding Value to 5 instead, 201.3 cm rounded up shows as 205 cm. The product rule's step of 10 is ignored for this embed.

Example use cases

  • US storefront, Round up — Set Unit Display Mode to Override Default Unit (in), Rounding Method Override to Round up, and enter a Rounding Value. Customers checking fit through a doorway or in a room see a size the product never exceeds.

  • EU storefront, Round to nearest — Keep Unit Display Mode on Default Unit, choose Round to nearest and set a Rounding Value such as 10. Displayed sizes stay as close as possible to the measured values.

  • Market that advertises minimum sizes, Round down — Choose Round down where you promise a minimum, such as seat width or interior space. The displayed value never overstates what the customer gets.

  • Global or general template, Use product rule — Leave the default so each product keeps the method and step size from its own rules.

These market settings are examples. Choose the method that matches how each market expects sizes to be shown.

PDF Settings

PDF generation settings — including branding, product details, pricing visibility, and dimension display — are covered in the PDF Export: Setup and Settings guide.

Theme

Override the default visual styling to match your brand colours.

Setting
Description

Button Color Override

Overrides the default button background colour.

Button Text Color Override

Overrides the default button text colour.

Background Color Override

Overrides the default background colour.

Basket Button Color Override

Overrides the default basket button background colour.

Option Group Highlight Color Override

Overrides the default group background colour.

Option Group Hover Color Override

Overrides the default group hover colour.

Opened Group Text Color Override

Overrides the default group text colour.

Hover Group Text Color Override

Overrides the default group hover text colour.

Theme Override Settings

Custom UI and Scripts

Upload and manage custom resources such as CSS or JavaScript to extend functionality or customise 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. Enable Use Custom CSS and paste your stylesheet into the field below.

Custom JavaScript

Inject custom JavaScript to extend functionality, respond to events, or integrate with third-party scripts. Enable Use Custom JavaScript and paste your code into the field below. Mimeeq embeds provide JavaScript events for product selection, configuration changes, add-to-basket actions, and basket submissions. See the Mimeeq JavaScript API documentation for the complete event reference.

Last updated

Was this helpful?