Interface: MimeeqApiConfig

Global configuration for the Mimeeq API and embeds.

This interface provides comprehensive customization options for the Mimeeq configurator's appearance and behavior. It allows for customizing PDF generation, image creation, and visual elements to align with brand guidelines and business needs.

The configuration can be set either at initialization or during runtime, providing flexibility for different implementation scenarios.

Example

// Setting configuration at page load
window.mimeeqAppConfig = {
  pdf: {
    logoPosition: 'LEFT',
    displayLogoAt: 'ALL_PAGES',
    afterOptionsContent: '<p class="disclaimer">Custom sizes available upon request.</p>'
  },
  image: {
    imageConfigurations: {
      pdf: {
        size: 2000,
        backgroundColor: '#FFFFFF'
      }
    }
  }
};

// Changing configuration after loading
window.mimeeqApp.config = {
  pdf: {
    logoPosition: 'RIGHT'
  }
};

Properties

icons?

optional icons: Partial<ApiIconsConfig>

Customization for built-in icons.

Allows replacing the default Mimeeq icons with custom SVGs that better match your brand identity and website design.

Icon customization creates a more seamless visual integration between your website and the configurator experience.

---

image?

optional image: ApiImageConfig

Configuration for image generation.

Controls how product images are created, formatted, and processed in different contexts throughout the configurator.

Image customization ensures consistent visual quality across different platforms and use cases while optimizing for performance.

---

pdf?

optional pdf: ApiPdfConfig

Configuration for PDF generation.

Controls how PDF documents are formatted, branded, and structured when users export product specifications or documentation.

PDF customization is essential for creating professional, branded documentation that accurately represents your products and brand.