iCUE Widget Specification

Widget API Version 1.0.1

QtWebEngine: 6.9.3

Chromium: 130.0.6723.192

Minimum iCUE: 5.44

This document provides the technical specification for the iCUE Widgets, including the HTML widget structure, manifest schema, and iCUE communication protocol.

Required Files

index.html – Main HTML entry point
manifest.json – Widget manifest and metadata
icon.svg or icon.png – Widget icon

Directory Structure

mywidget/
├── index.html
├── manifest.json
├── translation.json
├── modules/
│   └── CitySearch.mjs
├── scripts/
│   └── widget.js
├── styles/
│   └── style.css
└── resources/
    ├── icon.png
    └── thumbnail.png

HTML Structure

Widgets consist of four primary sections:

Head – Metadata, widget controls, widget name (<title>), and icon (<link rel="icon">)
Style – CSS definitions (inline or external file)
Body – Visual elements and DOM structure
Script – Widget logic and event handlers

Minimal HTML Example

<!doctype html>
<html lang="en">
	<head>
		<title>My Widget</title>
		<link rel="icon" type="image/x-icon" href="resources/icon.png" />
	</head>
	<body>
		<!-- Widget content -->
	</body>
</html>

Manifest Schema

The manifest.json file defines widget metadata, system requirements, and marketplace information. All paths in the manifest are relative to the manifest file location.

Schema Properties

Property	Type	Required	Description
`author`	`string`	Yes	Widget author name
`id`	`string`	Yes	Unique widget identifier in reverse-DNS format (e.g., `com.author.widget`)
`name`	`string`	Yes	Widget display name for marketplace
`description`	`string`	Yes	Widget description for marketplace
`version`	`string`	Yes	Widget version in semver format (e.g., `1.0.0`)
`preview_icon`	`string`	Yes	Path to widget icon file (relative to manifest)
`min_framework_version`	`string`	Yes	Minimum required iCUE Widget API version (e.g., `1.0.0`)
`os`	`object[]`	Yes	Array of supported operating systems objects. Each object requires a `platform` property. At the moment only `windows` is supported.
`supported_devices`	`object[]`	Yes	Array of supported device types (see Device Support)
`interactive`	`boolean`	No	Enable widget click handling on touch devices (default: `false`)
`required_plugins`	`string[]`	No	Array of required plugins in `namespace:Name:version` format
`modules`	`string[]`	No	Array of JavaScript module paths (see Module Integration)

Example Manifest

{
	"author": "Corsair Team",
	"id": "com.corsair.weatherwidget",
	"name": "Weather Widget",
	"description": "Display current weather and forecast",
	"version": "1.0.0",
	"preview_icon": "resources/icon.png",
	"min_framework_version": "1.0.0",
	"os": [
		{
			"platform": "windows"
		}
	],
	"supported_devices": [
		{
			"type": "dashboard_lcd",
			"features": ["sensor-screen"]
		},
		{
			"type": "pump_lcd"
		},
		{
			"type": "keyboard_lcd"
		}
	],
	"interactive": true,
	"required_plugins": [
		"widgetbuilder.sensorsdataprovider:Sensors:1.0",
		"widgetbuilder.mediadataprovider:Media:1.0"
	],
	"modules": [
		"modules/CitySearch.mjs"
	]
}

Device Support

The supported_devices array specifies compatible device types and optional feature requirements.

Device Types

Type	Description	Examples
`dashboard_lcd`	Dashboard displays	XENEON EDGE
`keyboard_lcd`	Keyboards with integrated LCD screens	VANGUARD 96, VANGUARD PRO 96
`pump_lcd`	AIO cooler pumps with LCD screens	iCUE LINK XC7/XD5 ELITE LCD

Device Features

Optional features array restricts widget to devices with specific capabilities.

Feature	Description
`sensor-screen`	Device supports sensor data display

Example:

"supported_devices": [
    {
        "type": "dashboard_lcd",
        "features": ["sensor-screen"]
    },
    {
        "type": "pump_lcd"
    }
]

HTML Meta Tags

Meta tags in the <head> section control widget presentation in iCUE and define user-configurable properties.

Required Meta Tags

Element	Description
`<title>`	Widget name displayed in iCUE in widgetselector. Use `tr('Name')` for translations
`<link rel="icon">`	Widget icon displayed in iCUE selector. Supported formats: SVG, PNG, ICO

Optional Meta Tags

Meta Tag Name	Description
`x-icue-widget-group`	Group name in widget selector in iCUE (for example `tr('Clock Face')`)
`x-icue-widget-preview`	Preview image path for widget selector (128×56px PNG)

Widgets in the same x-icue-widget-group will be grouped together in the widget selectorand displayed as variants of the same widget. Widgets with identical names are automatically grouped together.

<meta name="x-icue-widget-group" content="tr('Clock Face')" />

note

The tr() function enables localized group names.

The x-icue-widget-preview meta tag specifies a preview image shown in the widget selector before installation. The image should be 128x56 pixels in size and preferably in PNG format. The path to the image is relative to the index.html file.

<meta name="x-icue-widget-preview" content="resources/preview.png" />

Widget controls are user-configurable parameters defined as <meta> tags with name="x-icue-property". Each control becomes a global JavaScript variable in your widget.

<meta name="x-icue-property" content="textColor" data-label="Text Color" data-type="color" data-default="'#FFFFFF'" />

info

For complete documentation on available control types, attributes, and examples, see Widget Controls.

Property Groups

Property groups organize controls into panels in the iCUE. Groups are defined in a JSON array within a <script> element with id="x-icue-groups". JavaScript expressions are supported in title and info fields.

Group Schema

<script type="application/json" id="x-icue-groups">
	[
	    {
	        "title": "tr('Settings')",
	        "properties": ["option1", "option2"]
	        "info": "tr('Optional help text for this group')"
	    },
	    {
	        "title": "tr('Appearance')",
	        "properties": ["textColor", "backgroundColor", "backgroundMedia"],
	    }
	]
</script>

Group Properties

Property	Type	Required	Description
`title`	`string`	Yes	Group heading displayed in settings panel. Supports JavaScript expressions including `tr()` for translations
`properties`	`string[]`	Yes	Array of meta parameters (`content` values) to include in this group
`info`	`string`	No	Optional help text displayed as tooltip. Supports JavaScript expressions including `tr()`

Device-Specific Behavior

XENEON EDGE Custom Styles:

On XENEON EDGE devices, property groups containing textColor, accentColor, or backgroundColor automatically display a "Custom Style" toggle switch in the settings panel (second tab only). When disabled, the device's default color scheme is applied instead of custom values.

This behavior is device-specific and only applies to XENEON EDGE.

iCUE Events

iCUE injects script blocks into the widget's HTML page at runtime. These scripts provide:

Global variables for each meta parameter (e.g., textColor, fontSize)
iCUE global object with utility functions (see iCUE Global Object)
iCUE_initialized flag indicating API readiness
Plugin objects in window.plugins namespace more info about plugins

The injection occurs before the widget's own scripts execute, making all iCUE data immediately available.

Event handlers:

icueEvents = {
	onDataUpdated: onIcueDataUpdated,
	onICUEInitialized: onIcueInitialized,
};

function onIcueInitialized() {
	// Called once when iCUE API is ready
}

function onIcueDataUpdated() {
	// Called on property change; properties available as global variables
}

// Handle late script loading
if (iCUE_initialized) {
	onIcueInitialized();
	onIcueDataUpdated();
}

Event	Description
`onICUEInitialized`	Called once when iCUE API and all data are ready
`onDataUpdated`	Called when any meta parameter value changes

Plugin Events

Each loaded plugin provides its own event object. Register plugin callbacks using plugin{ModuleName}Events where {ModuleName} is the plugin's module name with namespace removed.

Example:

pluginSensorsdataproviderEvents = {
	onInitialized: onSensorPluginReady,
};

function onSensorPluginReady() {
	window.plugins.Sensorsdataprovider.sensorValueChanged.connect(function (sensorId, value) {
		// Handle sensor value change
	});
}

if (pluginSensorsdataprovider_initialized) {
	onSensorPluginReady();
}

info

For detailed plugin documentation, see Plugins.

iCUE Widget Specification

Widget File Structure

Required Files

Directory Structure

HTML Structure

Minimal HTML Example

Manifest Schema

Schema Properties

Example Manifest

Device Support

Device Types

Device Features

HTML Meta Tags

Required Meta Tags

Optional Meta Tags

Widget Grouping

Widget Preview

Widget Controls

Property Groups

Device-Specific Behavior

iCUE Events

Plugin Events

Widget File Structure​

Required Files​

Directory Structure​

HTML Structure​

Minimal HTML Example​

Manifest Schema​

Schema Properties​

Example Manifest​

Device Support​

Device Types​

Device Features​

HTML Meta Tags​

Required Meta Tags​

Optional Meta Tags​

Widget Grouping​

Widget Preview​

Widget Controls​

Property Groups​

Device-Specific Behavior​

iCUE Events​

Plugin Events​

Widget File Structure

Required Files

Directory Structure

HTML Structure

Minimal HTML Example

Manifest Schema

Schema Properties

Example Manifest

Device Support

Device Types

Device Features

HTML Meta Tags

Required Meta Tags

Optional Meta Tags

Widget Grouping

Widget Preview

Widget Controls

Property Groups

Device-Specific Behavior

iCUE Events

Plugin Events