Configure the host page

Define window.IconMediaConfig before loading embed.cfm. Account settings remain the preferred home for configuration that must follow a configurator key everywhere it is embedded. Host configuration is useful for site-specific behavior and development diagnostics.

<script>
  window.IconMediaConfig = {
    debugPlugins: false,
    plugins: [
      {
        id: 'analytics',
        enabled: true,
        options: {
          dataLayerName: 'YOUR_DATA_LAYER',
        },
      },
    ],
  }
</script>

<div id="icf_page"></div>
<script src="https://iconfigurators.app/src/embed.cfm?ky=CONFIGURATOR_KEY"></script>

Supported host fields

Field	Purpose
debugPlugins	Enables additional plugin diagnostics in the browser console.
plugins	Appends supported built-in plugin descriptors to account configuration.

A descriptor may contain id, enabled, required, order, options, and advisory capabilities. Built-in options are documented in Configure built-in plugins.

Trusted browser configuration

Host configuration is visible to everyone who can load the page. Do not include credentials, private customer data, API tokens, or server-only configuration.

Resolution order

Plugins can be configured or registered through four supported sources:

1. Customer preboot plugins queued before the visualizer starts.
2. Built-in descriptors returned by account settings.
3. Built-in descriptors in window.IconMediaConfig.plugins.
4. Plugins registered through the browser API after startup.

Active plugin IDs must be unique across all sources. Lower order values set up first.