Skip to content

Use the browser API

The host API is exposed at window.iConfigurator. It provides lifecycle status, supported commands, plugin registration, unregistration, and diagnostic snapshots.

js
const api = await window.iConfigurator.ready()

await api.commands.openBrands()
console.table(api.getPluginStatus())

Register a late plugin

js
const api = await window.iConfigurator.ready()

await api.registerPlugin({
  id: 'customer.route-logger',
  version: '1.0.0',
  apiVersion: '1.0',
  setup(pluginApi) {
    pluginApi.events.on('route:changed', (event) => {
      console.log('Visualizer route', event.data.to.fullPath)
    })
  },
})

Late plugins receive future events and currently mounted outlets. They cannot replay lifecycle events or startup-only hooks that have already completed.

Inspect state

js
const status = window.iConfigurator.getPluginStatus('customer.route-logger')
const snapshot = window.iConfigurator.getSnapshot()

console.log(status?.status)
console.table(snapshot.pluginErrors)

getSnapshot() returns a read-only public view of supported status and diagnostic data. Private configuration and application state are not exposed.

See the global API reference for every method.

Icon Visualizer developer documentation