@edv4h/usketch-plugin-debug-hud

中文文档
3.4.4发布于 2026/11/10MITTypeScriptES Module构建来源已验证近 30 天下载 2160
原始使用文档
文档目录3 节
  1. Controls panel
  2. Navigating many plugins
  3. Exposing plugin operations to the HUD

@edv4h/usketch-plugin-debug-hud

A screen-fixed control + debug panel. Toggle with the backtick key (`). Beyond inspection (shapes, events, FPS, sync, minimap) it is a universal control surface: every plugin operation can be driven from here, so a host app does not need to add bespoke UI per plugin.

import { createDebugHudPlugin } from "@edv4h/usketch-plugin-debug-hud";
const plugins = [/* ... */, createDebugHudPlugin()];

Hidden by default; press ` to open. Safe to ship in production (it only appears on toggle).

Controls panel

  • Tools — one button per registered tool (tools.getOrdered()), click to store.setActiveToolId(id).
  • Actions — every PluginAction a plugin registered (see below), grouped and rendered as buttons / parameter forms automatically.
  • Emit event — a raw fallback: type any event name + JSON payload and events.emit(...). Lets you drive operations a plugin hasn't (yet) exposed as an action.
  • Default style / Clear canvas — edit store default style; batch-delete.

Navigating many plugins

Each plugin with HUD contributions gets its own section. With dozens of plugins the dock would be a long scroll, so:

  • Plugin sections start collapsed; the header shows how many controls each holds. ⊟ in the dock header collapses every plugin section at once.
  • ☆ / ★ pins a plugin: pinned sections move to a "Pinned" group at the top (in pin order) and open automatically.
  • Open / pinned state persists in localStorage (usketch-debug-hud-dock).
  • The search box (sticky at the top, Esc clears) matches plugin name / id, action label / group / id, settings label / field names, and panel titles. Matching sections are force-expanded while a query is active; a plugin-name match shows all of that plugin's controls.

Exposing plugin operations to the HUD

Register actions in your plugin's setup via ctx.actions — the HUD renders a control for each with no app-side UI. Example (freedraw):

const off = ctx.actions.register({
  id: "freedraw:color",
  label: "Color",
  group: "Freedraw",
  params: [{ name: "color", type: "color", default: "#1e1e1e" }],
  run: ({ color }) => ctx.events.emit("freedraw:set-color", { color }),
});
// call off() in teardown

PluginAction fields: id, label, optional group / icon / order, optional params (ActionParam[] — string|number|boolean|color|enum), run(args), and optional isActive() / isEnabled() for toggle / contextual state. Parameterless actions render as a button; selection-contextual actions (e.g. "Flip selected card") use isEnabled() to gate on the current selection.

Migrated so far: freedraw, snap, background, card, sticky. Others follow the same one-liner pattern (emit the plugin's existing event from run).

版本与发布记录

@edv4h/usketch-plugin-debug-hud 共发布 29 个版本,首次发布于 2026/04/22;过去 12 个月发布了 29 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.4.4latest2026/11/104 天前
3.4.32026/11/104 天前
3.4.22026/11/067 天前
3.4.12026/11/068 天前
3.4.02026/11/0310 天前
3.3.132026/10/2519 天前

关于 @edv4h/usketch-plugin-debug-hud 的常见问题

如何安装 @edv4h/usketch-plugin-debug-hud?

在项目目录运行 npm install @edv4h/usketch-plugin-debug-hud,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=19)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@edv4h/usketch-plugin-debug-hud 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@edv4h/usketch-plugin-debug-hud 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@edv4h/usketch-plugin-debug-hud 可以商用吗?

@edv4h/usketch-plugin-debug-hud 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@edv4h/usketch-plugin-debug-hud 的下载量有多少?

根据 npm 官方下载统计,@edv4h/usketch-plugin-debug-hud 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,160 次,日均约 72 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@edv4h/usketch-plugin-debug-hud 还在维护吗?

最新版本 3.4.4 发布于 2026/11/10(4 天前);至今共发布 29 个版本,其中过去 12 个月发布了 29 个;首次发布于 2026/04/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。