devtools
Drop-in inspector panel for any json-render app. Use when the user wants to debug a generative UI, inspect the spec tree, edit state at runtime, see dispatched actions, follow stream patches live, browse a catalog, or pick DOM elements to find their spec keys. Triggers include "add devtools", "debug json-render", "inspect the spec", "why is this element not rendering", "see the state at runtime", or requests to tap streams / capture action logs for `@json-render/devtools`.
vercel-labs · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add vercel-labs/json-render --skill devtools技能说明
name: devtools
description: Drop-in inspector panel for any json-render app. Use when the user wants to debug a generative UI, inspect the spec tree, edit state at runtime, see dispatched actions, follow stream patches live, browse a catalog, or pick DOM elements to find their spec keys. Triggers include "add devtools", "debug json-render", "inspect the spec", "why is this element not rendering", "see the state at runtime", or requests to tap streams / capture action logs for @json-render/devtools.
@json-render/devtools
A floating inspector panel for json-render apps. Framework-agnostic core + per-framework adapters (React, Vue, Svelte, Solid).
Production-safe: the component renders null when NODE_ENV === "production".
Install
Install the core package plus the adapter that matches the host app's renderer.
# React
npm install @json-render/devtools @json-render/devtools-react
# Vue
npm install @json-render/devtools @json-render/devtools-vue
# Svelte
npm install @json-render/devtools @json-render/devtools-svelte
# Solid
npm install @json-render/devtools @json-render/devtools-solid
Drop-in usage
Place <JsonRenderDevtools /> anywhere inside the existing <JSONUIProvider> (or framework equivalent). No other wiring required.
React
import { JsonRenderDevtools } from "@json-render/devtools-react";
<JSONUIProvider registry={registry} handlers={handlers}>
<Renderer spec={spec} registry={registry} />
<JsonRenderDevtools spec={spec} catalog={catalog} messages={messages} />
</JSONUIProvider>;
Vue
<script setup>
import { JsonRenderDevtools } from "@json-render/devtools-vue";
</script>
<template>
<JSONUIProvider :registry="registry">
<Renderer :spec="spec" :registry="registry" />
<JsonRenderDevtools :spec="spec" :catalog="catalog" :messages="messages" />
</JSONUIProvider>
</template>
Svelte
<script>
import { JsonRenderDevtools } from "@json-render/devtools-svelte";
</script>
<JSONUIProvider {registry}>
<Renderer {spec} {registry} />
<JsonRenderDevtools {spec} {catalog} {messages} />
</JSONUIProvider>
Solid
import { JsonRenderDevtools } from "@json-render/devtools-solid";
<JSONUIProvider registry={registry}>
<Renderer spec={spec()} registry={registry} />
<JsonRenderDevtools
spec={spec()}
catalog={catalog}
messages={messages()}
/>
</JSONUIProvider>;
Controls
- Floating toggle appears bottom-right.
- Hotkey:
Ctrl/Cmd+Shift+J(configurable viahotkeyprop). - Drawer is resizable; height persists to localStorage.
Props
spec(Spec | null) — current spec.catalog(Catalog | null) — catalog definition; required for the Catalog panel.messages(UIMessage[]) — AI SDKuseChatmessages; scanned for spec data parts.initialOpen(boolean) — start open.position("bottom-right" | "bottom-left" | "right") — dock + toggle corner."bottom-*"docks at the bottom;"right"docks at the right edge full-height (recommended for app-shells that already use100vhor fixed bottom bars).hotkey(string | false) —"mod+shift+j"by default.bufferSize(number) — event ring-buffer cap, default 500.reserveSpace(boolean, defaulttrue) — when true the panel pushes the host app by applyingpadding-bottom/padding-rightonbody. Set tofalseto keep the panel as a pure overlay.allowDockToggle(boolean, defaulttrue) — show a toolbar button so the user can flip the panel between bottom-dock and right-dock. User choice persists tolocalStorageand overridespositionon subsequent mounts. Passfalseto lock the dock toposition.onEvent((DevtoolsEvent) => void) — optional tap.
Panels
- Spec — element tree rooted at
spec.root; props/visibility/events/watchers detail; integratedvalidateSpecwarnings. - State — every JSON Pointer path with inline edit via
store.set. - Actions — dispatched actions timeline (name, params, result/error, duration).
- Stream — spec patches, text chunks, token usage, lifecycle markers grouped by generation.
- Catalog — components + actions declared in the catalog with prop chips.
Picker (toolbar)
The element picker is a toolbar button in the panel header (Chrome-DevTools-style), not a tab. Click it to activate pick mode, then click any rendered element in the page — selection jumps to the Spec tab with that element focused. Esc cancels.
Reserved space & docking
The panel can dock at the bottom or the right edge, and by default the user can flip between the two with a toolbar button (the choice persists to localStorage). Set allowDockToggle={false} if the host app only works with one dock — the button is hidden and the dock is locked to position.
Pick an initial dock that fits your layout:
- Bottom dock (default) — works best for docs / marketing / content-flow sites and for app shells built with a
height: 100%chain (html { height: 100% }→body { height: 100% }→.app { height: 100% }). The panel writes its height to--jr-devtools-offset-bottomand applies matchingpadding-bottomtobody, so non-fixed content naturally makes room. - Right dock (
position="right") — recommended for app-shell layouts that use100vhorposition: fixed; bottom: 0. Right docking sidesteps the bottom edge entirely and writes its width to--jr-devtools-offset-rightinstead.
Apps that use 100vh, position: fixed, or position: sticky can opt specific elements in with the published CSS custom properties:
.composer { bottom: var(--jr-devtools-offset-bottom, 0); }
.sidebar { right: var(--jr-devtools-offset-right, 0); }
.app-shell { height: calc(100vh - var(--jr-devtools-offset-bottom, 0)); }
If the automatic body padding causes problems with a particular layout, pass reserveSpace={false} to make the panel a pure overlay — the CSS custom properties are still pu