Skip to content

The Open Standard for Generative UI

2.8 KB
Raw Blame

@openuidev/devtools

Development-only UI widget for OpenUI apps. Renders a floating button that opens OpenUI Inspect, listing the events captured by @openuidev/observability.

Usage

If your app uses @openuidev/react-lang, the widget shows up automatically.

You can also mount it yourself. All props are forwarded into that widget:

import { OpenUIDevtools } from "@openuidev/devtools";

function App() {
  return (
    <>
      {/* your app */}
      <OpenUIDevtools theme="dark" position="bottom-left" maxEvents={100} />
    </>
  );
}
Prop Default Notes
version @latest Pin CDN tag: "0" (major), "0.1" (minor), or "0.1.0" (exact).
theme, position, maxEvents, errorsOnly, autoOpenOnError, enabled see below Forwarded into the CDN widget as-is

A manually mounted instance always wins over the auto-mount — only one instance ever renders.

Publishing a new version of this package updates the CDN file on jsDelivr automatically (no separate CDN setup). The browser build is dist/devtools.browser.js inside the published tarball.

The widget renders nothing in production builds (NODE_ENV === "production") unless enabled is passed explicitly.

CSP

script-src must allow cdn.jsdelivr.net for the fetch to succeed. If it's blocked, the widget silently fails to appear — the rest of the app is unaffected.

In development, createLibrary() registers the live library with the widget. A stream event's Debug button opens OpenUI Debug in its own tray — an editor against that library (host CSS included), with Render / Validation / Tree / JSON / Stream panels and simulated stream playback.

Debug renders through the host's own Renderer. Its previews stay off the event bus so a Stream replay does not append cards to Inspect.

Props

Prop Default Description
enabled dev-only Force the widget on/off.
position "bottom-right" Corner for the toggle button: top-left/top-right/bottom-*.
maxEvents 50 How many events to keep; oldest are dropped first.
errorsOnly true Capture only error/warning events, or all.
autoOpenOnError true Initial state of the "auto-open on error" setting.
theme "light" Initial widget chrome theme: "light" or "dark" (Settings overrides).
version @latest CDN pin: "0" / "0.1" / "0.1.0". Omit for @latest.