Skip to main content

Widget Development

A reference for working inside an Invent widget repo — how to configure the widget, how it plugs into the dashboard, and the platform APIs (httpClient, notifications, React Query, OAuth, state sharing, WebSocket, extensions) you'll call from inside it.

This guide assumes you've already scaffolded a widget using the AI Quickstart. For what a widget is and its basic components (project structure, configuration, context, app states), see the Widget Overview. This guide doesn't cover creating the widget (the create-invent-widget skill does that) or shipping changes (see Creating an MR).

How this relates to the Manual

This documentation is organized in two layers:

  • Widget Development (this section) — the platform, oriented for developers. How the platform fits together — the portal, dashboards, and the micro-app model — and how you configure, integrate, and extend a widget within it. Breadth over depth: current, curated, example-first. It's the place to start.
  • Manual — the exhaustive subsystem reference. The full, stable spec and internals for each subsystem (config schema, layout math, theming tokens, the BfF, extensions, Module Federation, the Widget Store API, White Label, and more). Depth over breadth.

Each topic has one canonical home. Where this Reference summarizes something that has a full specification, it links into the Manual with a callout:

Full spec

The exhaustive definition lives in the linked Manual page — this Reference gives you the working version.