devtools-react

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

@json-render/devtools-react

@json-render/devtools-react

React adapter for the json-render devtools panel. Read
skills/devtools/SKILL.md
for the shared panel capabilities, props, docking behavior, and server-side stream taps.
json-render devtools 面板的 React adapter。阅读
skills/devtools/SKILL.md
,了解共享面板功能、props、停靠行为和 server-side stream taps。

Install

安装

bash
npm install @json-render/devtools @json-render/devtools-react
bash
npm install @json-render/devtools @json-render/devtools-react

Mount the panel

挂载面板

Mount
JsonRenderDevtools
inside the existing React json-render provider so it can observe the renderer's state, actions, and streams:
tsx
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>;
The component renders nothing in production builds. The panel provides the shared devtools controls, including the
Ctrl
/
Cmd
+
Shift
+
J
shortcut.
在现有的 React json-render provider 内挂载
JsonRenderDevtools
,使其能够观察 renderer 的 state、actions 和 streams:
tsx
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>;
该组件在生产构建中不会渲染任何内容。面板提供共享 devtools 控件,包括
Ctrl
/
Cmd
+
Shift
+
J
快捷键。

Imperative controls

命令式控制

Use
useJsonRenderDevtools
from any mounted React descendant:
tsx
import { useJsonRenderDevtools } from "@json-render/devtools-react";

const devtools = useJsonRenderDevtools();
devtools?.open();
devtools?.toggle();
devtools?.recordEvent({ kind: "stream-text", at: Date.now(), text: "hi" });
The hook returns
null
in production or before the component has mounted. Keep server-side stream instrumentation in
@json-render/devtools
.
从任意已挂载的 React 后代组件中使用
useJsonRenderDevtools
:
tsx
import { useJsonRenderDevtools } from "@json-render/devtools-react";

const devtools = useJsonRenderDevtools();
devtools?.open();
devtools?.toggle();
devtools?.recordEvent({ kind: "stream-text", at: Date.now(), text: "hi" });
在生产环境或组件尚未挂载时,该 Hook 返回
null
。请将 server-side stream instrumentation 保留在
@json-render/devtools
中。