Skip to content

Canvas (macOS 应用)

macOS 应用使用 WKWebView 嵌入了一个由 agent 控制的 Canvas 面板。它是一个轻量级的可视化工作区,用于 HTML/CSS/JS、A2UI 和小型交互式 UI 界面。

Canvas 位置

Canvas 状态存储在 Application Support 下:

  • ~/Library/Application Support/OpenClaw/canvas/<session>/...

Canvas 面板通过自定义 URL scheme 提供这些文件:

  • openclaw-canvas://<session>/<path>

示例:

  • openclaw-canvas://main/<canvasRoot>/main/index.html
  • openclaw-canvas://main/assets/app.css<canvasRoot>/main/assets/app.css
  • openclaw-canvas://main/widgets/todo/<canvasRoot>/main/widgets/todo/index.html

如果根目录下不存在 index.html,应用会显示内置的脚手架页面

面板行为

  • 无边框、可调整大小的面板,锚定在菜单栏(或鼠标光标)附近。
  • 记住每个会话的大小/位置。
  • 当本地 canvas 文件更改时自动重新加载。
  • 一次只显示一个 Canvas 面板(根据需要切换会话)。

可以从设置 → Allow Canvas 禁用 Canvas。禁用后,canvas 节点命令返回 CANVAS_DISABLED

Agent API 接口

Canvas 通过 Gateway WebSocket 暴露,因此 agent 可以:

  • 显示/隐藏面板
  • 导航到路径或 URL
  • 执行 JavaScript
  • 捕获快照图像

CLI 示例:

bash
openclaw nodes canvas present --node <id>
openclaw nodes canvas navigate --node <id> --url "/"
openclaw nodes canvas eval --node <id> --js "document.title"
openclaw nodes canvas snapshot --node <id>

注意:

  • canvas.navigate 接受本地 canvas 路径http(s) URL 和 file:// URL。
  • 如果传递 "/",Canvas 会显示本地脚手架或 index.html

Canvas 中的 A2UI

A2UI 由 Gateway canvas host 托管并在 Canvas 面板内渲染。当 Gateway 广播 Canvas host 时,macOS 应用会在首次打开时自动导航到 A2UI host 页面。

默认 A2UI host URL:

http://<gateway-host>:18793/__openclaw__/a2ui/

A2UI 命令 (v0.8)

Canvas 当前接受 A2UI v0.8 的服务器→客户端消息:

  • beginRendering
  • surfaceUpdate
  • dataModelUpdate
  • deleteSurface

不支持 createSurface (v0.9)。

CLI 示例:

bash
cat > /tmp/a2ui-v0.8.jsonl <<'EOFA2'
{"surfaceUpdate":{"surfaceId":"main","components":[{"id":"root","component":{"Column":{"children":{"explicitList":["title","content"]}}}},{"id":"title","component":{"Text":{"text":{"literalString":"Canvas (A2UI v0.8)"},"usageHint":"h1"}}},{"id":"content","component":{"Text":{"text":{"literalString":"If you can read this, A2UI push works."},"usageHint":"body"}}}]}}
{"beginRendering":{"surfaceId":"main","root":"root"}}
EOFA2

openclaw nodes canvas a2ui push --jsonl /tmp/a2ui-v0.8.jsonl --node <id>

快速测试:

bash
openclaw nodes canvas a2ui push --node <id> --text "Hello from A2UI"

从 Canvas 触发 agent 运行

Canvas 可以通过 deep links 触发新的 agent 运行:

  • openclaw://agent?...

示例 (在 JS 中):

js
window.location.href = "openclaw://agent?message=Review%20this%20design";

除非提供有效密钥,否则应用会提示确认。

安全注意事项

  • Canvas scheme 阻止目录遍历;文件必须位于会话根目录下。
  • 本地 Canvas 内容使用自定义 scheme(无需回环服务器)。
  • 仅在明确导航时才允许外部 http(s) URL。