Global browser API

window.iConfigurator provides the host-page integration boundary.

type IConfiguratorGlobalApi = {
  readonly status: 'idle' | 'booting' | 'ready' | 'failed'
  ready(): Promise<IConfiguratorHostApi>
  registerPlugin(plugin, options?): Promise<PluginRegistration>
  unregisterPlugin(id: string): boolean
  getPluginStatus(): PluginRegistration[]
  getPluginStatus(id: string): PluginRegistration | undefined
  getSnapshot(): ConfiguratorSnapshot
}

status

The current bootstrap status. Use ready() or the document lifecycle events instead of polling it.

ready()

Resolves with the host API after successful startup. It rejects after a terminal startup failure.

const api = await window.iConfigurator.ready()

registerPlugin(plugin, options?)

Registers a plugin after the plugin system is available. The promise resolves with its registration record. Startup lifecycle events are not replayed.

unregisterPlugin(id)

Disposes an active plugin and resources registered through the plugin API. Returns true when a matching active registration was found.

getPluginStatus(id?)

Returns one registration or all registrations. Status values are queued, registered, setting-up, ready, failed, disabled, and disposed.

getSnapshot()

Returns a read-only public snapshot of configurator status, plugin registrations, plugin errors, loaded plugin files, campaigns, landing sections, the active modal, route, and basic configuration.

See Registration and diagnostics types for the complete fields.

The host API returned from ready() also exposes commands.