Widgets

Build widgets — single-page web apps that run inside framed sections of the Doohnut player. This section is the entry point for authors: SDK usage, local development with Vite, and the wire-level protocol.

Where to start

1. Widget SDK — install doohnut-widget-sdk, handle init / configUpdate / frame visibility, and ship a READY handshake.
2. Local development — use vite-plugin-doohnut-widget for a mock host, validation, and optional .tgz output.
3. DX walkthrough — bootstrap → develop → debug → deploy using the minimal dx-walkthrough-vue example.
4. Runtime protocol — full postMessage reference if you are not using the SDK or are debugging the host.
5. Examples — sample widgets in the repo (Vue SPA, debugger) with links to source and pack commands.

Canonical sources in the monorepo stay in docs/widgets/ and packages/widget-sdk. This site syncs key English pages from there on each build.

More in the monorepo

• widgets.md — packaging, configuration tiers, security pointers, and implementation status.
• vite-plugin-doohnut-widget — README for overlay options, doohnut validation, and DOOHNUT_PACK.