Canvas
Agent-controlled Canvas panel embedded via WKWebView + custom URL scheme
macOS 应用使用 ''WKWebView'' 嵌入了由代理控制的''Canvas 面板''。它
是一个轻量级的 HTML/CSS/JS、A2UI 和小型交互式
UI 表面的可视化工作区。
Canvas 的位置
Canvas 状态存储在 Application Support 下:
- ''~/Library/Application Support/OpenClaw/canvas/<session>/...''
Canvas 面板通过自定义 URL 方案提供这些文件:
- ''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 面板(根据需要切换会话)。
可以从设置 → 允许 Canvas禁用 Canvas。禁用时,canvas
节点命令返回 ''CANVAS_DISABLED''。
代理 API 表面
Canvas 通过Gateway WebSocket公开,因此代理可以:
- 显示/隐藏面板
- 导航到路径或 URL
- 评估 JavaScript
- 捕获快照图像
CLI 示例:
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 主机托管,并在 Canvas 面板内呈现。
当 Gateway 广播 Canvas 主机时,macOS 应用会自动导航到
首次打开时的 A2UI 主机页面。
默认 A2UI 主机 URL:
http://'<gateway-host>':18793/__openclaw__/a2ui/
#
A2UI 命令(v0.8)
Canvas 目前接受A2UI v0.8 服务器→客户端消息:
- ''beginRendering''
- ''surfaceUpdate''
- ''dataModelUpdate''
- ''deleteSurface''
''createSurface'' (v0.9) 不支持。
CLI 示例:
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>'快速冒烟测试:
openclaw nodes canvas a2ui push --node '<id>' --text "Hello from A2UI"
从 Canvas 触发代理运行
Canvas 可以通过深度链接触发新的代理运行:
- ''openclaw://agent?...''
示例(在 JS 中):
window.location.href = "openclaw://agent?message=Review%20this%20design";
除非提供有效密钥,否则应用会提示确认。
安全说明
- Canvas 方案阻止目录遍历;文件必须位于会话根目录下。
- 本地 Canvas 内容使用自定义方案(不需要回环服务器)。
- 外部 ''http(s)'' URL 仅在显式导航时允许。