plugins/canvas/
  sdk/            # 插件 SDK(类型 + automatic JSX 运行时 + 构建助手)
  template/       # 起步模板:复制它开始写新插件
  markdown/       # 每个插件一个独立目录
    package.json
    build.mjs     # 一行 buildPlugin,产物名取目录名 → dist/markdown.js
    tsconfig.json
    src/index.tsx # 插件源码(默认导出 definePlugin(...))
    README.md
  svg/ html/ panorama/ sticky-note/ ...

快速开始

cp -r plugins/canvas/template plugins/canvas/my-plugin
cd plugins/canvas/my-plugin
# 改 package.json 的 name;改 src/index.tsx 里的 id / nodes[].type
npm install
npm run dev        # watch 构建,产物同步到 web/public/plugins/my-plugin.js
npm run typecheck  # tsc --noEmit,类型自检

产物名取目录名,复制后记得把目录改成插件名。

构建 / 发布 / 升级

cd plugins/canvas/<name>
npm install
npm run build   # → dist/<name>.js,并同步到 web/public/plugins/<name>.js
npm run dev     # watch,改动自动构建并同步

把 dist/<name>.js 托管到任意静态地址(CDN、GitHub Raw、对象存储),用户在画布「节点插件」管理器填该 URL 安装。升级时重新构建覆盖同一 URL,用户点「更新」即可。

官方插件注册表

本项目官方插件由 CI 集中构建后发布到孤儿分支 plugins-dist(构建产物不进 git),画布「节点插件」面板顶部的官方插件区经 jsDelivr 从该分支远程拉取并一键安装;第三方插件仍走下方「第三方插件」的 JS URL 安装。构建脚本与发布说明见 registry/;清单地址可用 VITE_PLUGIN_REGISTRY_URL 覆盖成自建来源。

本地开发

npm run dev 起 watch,产物会同步到 web/public/plugins/<name>.js。此后有两种方式在画布里用到它:

方式一(推荐):自动发现。 画布启动时会扫描 web/public/plugins/ 下的插件,自动加入「节点插件」管理器列表,默认关闭;打开开关即启用。无需手动填 URL,启用时会按文件重新拉取,配合 watch 改完刷新即最新。

方式二:VITE_DEV_PLUGINS。 在 web/.env.local 声明(逗号分隔多个),这些插件每次刷新页面都重新拉取并直接激活(不缓存、不落库、无开关):

VITE_DEV_PLUGINS=/plugins/markdown.js,/plugins/svg.js

再起画布 web(npm run dev)。流程即:改 src/index.tsx → watch 自动构建 → 刷新画布看到最新效果,无需反复安装。

用 SDK 写插件

默认导出 definePlugin({...})(对象形式,无需再 const { React } = runtime):

import { definePlugin, useState } from "@infinite-canvas/plugin-sdk";
import type { CanvasNodeContentProps } from "@infinite-canvas/plugin-sdk";

function Content({ ctx }: CanvasNodeContentProps) {
    const [n, setN] = useState(0);
    return (
        <button onMouseDown={(e) => e.stopPropagation()} onClick={() => setN((v) => v + 1)} style={{ color: ctx.theme.node.text }}>
            {ctx.node.title}: {n}
        </button>
    );
}

export default definePlugin({
    id: "my-plugin",
    name: "我的插件",
    version: "1.0.0",
    css: "…",                 // 可选:插件样式,自动注入/清理
    nodes: [ /* CanvasNodeDefinition[] */ ],
    setup(app) { return () => {}; }, // 可选,返回清理函数;app 含 injectCSS/emit/on
});

SDK 导出的 hooks(useState/useEffect/useMemo/useRef/...)运行时转发宿主 React,类型来自 @types/react。SDK 与依赖接入见 sdk/README.md。

CanvasNodeDefinition

{
    type: string;                 // 建议 "<pluginId>:<name>",全局唯一
    title: string;                // 创建菜单/默认标题
    icon: ReactNode;              // emoji 字符串或任意 ReactNode
    description?: string;
    defaultSize: { width, height };
    defaultMetadata?: object;     // 新建节点初始 metadata(文本内容放 content)
    minimapColor?: string;
    showInCreateMenu?: boolean;   // 默认 true
    hasSourceHandle?: boolean;    // 右侧输出连接点,默认 true
    keepAspectRatio?: (node) => boolean;
    resource?: (node) => { kind: "text"|"image"|"video"|"audio", text?, url? } | null; // 作为上游输入被消费时输出什么
    Content: ({ ctx }) => ReactNode;         // 节点主体渲染
    Panel?: ({ ctx, onClose }) => ReactNode; // 可选:节点下方面板
    toolbar?: (ctx) => Array<{ id, title, label, icon, onClick, danger? }>; // 追加到 hover 工具栏
    onDoubleClick?: (ctx) => boolean;        // 返回 true 表示已处理双击
}

ctx:节点与画布交互接口

Content / Panel / toolbar 都会拿到 ctx(类型 CanvasNodeContext):

能力	说明
`ctx.node`	当前节点数据(含 `metadata.content` 等)
`ctx.theme` / `ctx.scale`	当前画布主题 token 与缩放,用来让 UI 跟随主题
`ctx.updateMetadata(patch)`	更新自身 metadata(如保存内容)
`ctx.updateNode(patch)`	更新自身 title/width/height
`ctx.getNode(id)` / `ctx.getNodes()` / `ctx.getConnections()`	读画布
`ctx.getUpstream()` / `ctx.getDownstream()`	取上/下游相连节点
`ctx.applyOps(ops)`	用画布指令集增删节点/连线、选择、触发生成(见下)
`ctx.emit(event, payload)` / `ctx.on(event, handler)`	节点/插件间事件通信
`ctx.storage`	插件私有持久化(按插件 id 命名空间)

metadata 的内置字段(content、status、model…)是强类型;插件写入的自定义字段读出为 unknown,按需 as 断言(参考 sticky-note 的 pluginColor)。

画布指令集(ctx.applyOps)

ctx.applyOps([
    { type: "add_node", id?, nodeType, title?, x?, y?, width?, height?, metadata? },
    { type: "update_node", id, patch?, metadata? },
    { type: "delete_node", id? | ids? },
    { type: "connect_nodes", fromNodeId, toNodeId },
    { type: "delete_connections", id? | ids? | all? },
    { type: "select_nodes", ids },
    { type: "set_viewport", viewport },
    { type: "run_generation", nodeId, mode?, prompt? },
]);

重依赖 / 资源

重依赖(three.js、marked 等):不要打进 bundle,运行时 await import("https://esm.sh/...") 动态加载(esbuild 自动 external);在 src/env.d.ts 声明该模块以通过 tsc。参考 panorama/、markdown/。
CSS:写独立 .css,import css from "./styles.css" 拿到字符串(esbuild text loader),放到 css 字段自动注入/清理;src/env.d.ts 声明 *.css。参考 markdown/。
HTML:HTML 节点把 HTML 字符串塞进 sandbox iframe 的 srcDoc,自带 <style>,不需要插件级 CSS。参考 html/。

兼容说明

加载器仍接受默认导出为工厂函数 (runtime) => CanvasPlugin(用 runtime.React)或普通对象;老的 JS 插件无需改动即可运行。SDK 的 automatic JSX 让新插件走对象形式,更简洁。

注意

插件代码会在画布页面内直接执行,可访问浏览器本地数据(含 AI API Key)。发布前请自审,用户也只应安装可信来源。
交互控件记得 onMouseDown={(e) => e.stopPropagation()}(避免触发节点拖拽),滚动区域加 onWheel={(e) => e.stopPropagation()} 与容器 data-canvas-no-zoom(避免被画布缩放拦截)。