Extend Icon Visualizer with plugins

A plugin is trusted browser code that extends one Icon Visualizer instance through supported public interfaces without depending on private application code.

Choose a capability

Goal	Capability
Observe product or lifecycle activity	Events
Transform approved data	Hooks
Navigate or open app-owned UI	Commands
Add a badge, action, or small UI contribution	UI outlets
Add a complete landing-page section	api.ui.registerLandingSection()
Open a trusted custom workflow	api.ui.openModal()
Register a structured marketing prompt	api.campaigns.register()

Plugin shape

Every plugin declares a stable ID, its own release version, the supported Plugin API version, and a setup callback:

import { PLUGIN_API_VERSION, definePlugin } from '@iconfigurators/plugin-sdk'

export default definePlugin({
  id: 'customer.example',
  version: '1.0.0',
  apiVersion: PLUGIN_API_VERSION,
  setup(api) {
    api.events.on('wheel:viewed', (event) => {
      console.log(event.data.wheelImageId)
    })
  },
})

Registration timing

• Preboot: register before embed.cfm for startup events and settings:filter.
• Configured built-in: enable a reviewed built-in through account or host settings.
• Late: call window.iConfigurator.registerPlugin() for future events and active UI.

Start with Build your first plugin.

When you have the project structure in place, use the plugin recipes for task-oriented implementations or study the complete plugin examples.