跳转到内容

Slots 贡献协议

本页由当前 SDK 声明自动生成。 导入入口:@woohaa3/frontend/extension-api。

返回接口索引

agent-assistant.configuration · agent-assistant.hosting-source · agent-assistant.provider-balance · ai-center.generation-history · app.route · authoring.delivery · authoring.generate · canvas.catalog-item-action · canvas.context-menu · canvas.create-option · canvas.document-workspace · canvas.focus-header · canvas.focus-workspace · canvas.minimap · canvas.minimap-side · canvas.minimap-top · canvas.node-action · canvas.node-drop · canvas.node-template · canvas.overlay · canvas.selection-action · canvas.toolbar · canvas.toolbar-action · canvas.toolbar-status · canvas.topbar · canvas.topbar-status · dialog.renderer · execution.prompt-skill · input.drop · input.paste · provider-credentials.top · settings.plugin-config

agent-assistant.configuration

"agent-assistant.configuration": {
kind: "login" | "installed" | "api-key" | "provider-login";
label: string;
description?: string;
icon?: string;
modelTypes?: readonly import("@woohaa3/contracts").CanvasTaskModelType[];
setupOrder?: number;
providerId?: string;
configured?: {
getSnapshot: () => boolean;
subscribe: (listener: () => void) => () => void;
};
render: ComponentType<{
connectionId?: string;
onSaved?: (connectionId: string) => void;
}>;
};

关联类型:CanvasTaskModelType

agent-assistant.hosting-source

临时图床来源的「如何让它就绪」面板(可选)。

能力中心按候选的 ownerExtensionId 找到该贡献并渲染,替代通用的凭据表单。用于来源的 就绪条件不是可编辑配置、而是扩展自己的账号状态(例如需要先扫码登录)的场景;宿主不按 扩展 ID 分支,也不在只读列表里替扩展发起登录。

"agent-assistant.hosting-source": {
ownerExtensionId: string;
render: ComponentType<{
onSaved?: () => void;
}>;
};

agent-assistant.provider-balance

提供商列表行里的余额读数(可选)。

宿主在「模型提供商」列表按 providerId 找到该贡献并渲染;扩展自己决定读取方式与展示 文案,宿主不认识任何具体供应商的余额接口。没有贡献或没有可读余额时不占位。

"agent-assistant.provider-balance": {
providerId: string;
render: ComponentType;
};

ai-center.generation-history

Read-only canvas history workspace. The contributing feature owns its state and media.

"ai-center.generation-history": {
render: ComponentType<{
canvasId: string;
active: boolean;
onClose: () => boolean;
}>;
};

app.route

"app.route": {
path: string;
render: ComponentType<RouteProps>;
};

关联类型:RouteProps

authoring.delivery

模型/镜头 authoring 生成入口 UI。

宿主持有目标身份、门禁与 MCP 指引,并内置渲染生成面板(提示词/来源连接选择/提交/会话)。 个人生成插件通过本 slot 只声明来源身份与可用连接,不再贡献面板 UI。 宿主 MUST NOT 导入具体插件的面板或业务实现。

sourceId/sourceLabel: 贡献方只声明自己服务的来源(对应连接 adapterId)与可用连接。宿主按 owner 可见连接渲染 来源/连接选择,来源覆盖不了;同一来源多个贡献仍按 priority 取首个。 缺省 sourceId 时回退到贡献 id,保持既有单一来源兼容。

"authoring.delivery": {
resolve(input: {
canvasId: string;
nodeId: string;
data: import("@woohaa3/contracts").CanvasNodeData | undefined;
}): AssistantDeliveryTarget | null;
};

关联类型:CanvasNodeData · AssistantDeliveryTarget

authoring.generate

"authoring.generate": {
render?: AuthoringGenerationComponent;
sourceId?: string;
sourceLabel?: string;
};

关联类型:AuthoringGenerationComponent

canvas.catalog-item-action

画布目录条目上的动作。

宿主在画布切换器的每个条目旁渲染贡献;贡献方自行判断在本条目是否呈现。用于把 「把这张本地画布同步到远端」这类动作做成显式操作,而不是登录后的默认行为。

"canvas.catalog-item-action": CatalogItemActionContribution;

关联类型:CatalogItemActionContribution

canvas.context-menu

"canvas.context-menu": {
items: (context: ContextMenuContext) => CanvasContextMenuItem[];
onSelect: (itemId: string, context: ContextMenuContext) => void;
};

关联类型:ContextMenuContext · CanvasContextMenuItem

canvas.create-option

新建画布时可勾选的选项(例如「同时同步到远端」)。

"canvas.create-option": CanvasCreateOptionContribution;

关联类型:CanvasCreateOptionContribution

canvas.document-workspace

独立文档工作区呈现(编辑扩展工作区,design D1/D4)。

当 Canvas Navigation mode 为 document-workspace 时,宿主渲染唯一贡献;它与节点聚焦 互斥,且不伪造画布节点。贡献方自己提供不透明内容背景、取景与输入 owner;宿主只提供内容 矩形布局与 2D 媒体 overlay 的通用清理。

"canvas.document-workspace": {
isAvailable?: (documentId: string) => boolean;
layout?: FocusLayoutSource;
render: ComponentType<CanvasSlotProps & {
document?: {
documentId: string;
} | null;
}>;
};

关联类型:FocusLayoutSource · CanvasSlotProps

canvas.focus-header

公共聚焦标题栏的可选贡献;插件拥有其内容和交互。

"canvas.focus-header": {
position?: "before-title" | "after-title";
render: ComponentType<{
nodeId: string;
}>;
};

canvas.focus-workspace

通用 extension 聚焦工作区。

扩展为一个 focus kind(如 "extension")提供工作区覆盖层;宿主在 node-focus 且 kind 匹配 并通过可选 matches 时渲染该贡献,并隐藏普通画布邻居(工具栏/面板/提示/菜单),使「普通画布与其他 focus mode 不 并行响应」。宿主只按通用 kind/contribution 处理,MUST NOT import 任何具体业务工作区实现。 非模态、铺满内容区或以自身 surface 覆盖;进入/退出由 Canvas Navigation 原子管理。

"canvas.focus-workspace": {
kind: string;
matchesFocus?: (input: {
canvas: import("@woohaa3/contracts").ServerCanvas | null;
focus: {
nodeId: string;
kind: string;
};
}) => boolean;
validate?: (props: CanvasSlotProps) => string | null;
layout?: FocusLayoutSource;
exclusive?: boolean;
render: ComponentType<CanvasSlotProps>;
};

关联类型:ServerCanvas · CanvasSlotProps · FocusLayoutSource

canvas.minimap

右下角控件面板顶部的小地图(2026-10-26)。

宿主只提供面板位置与画布 props;贡献自己读取 working 画布、订阅本地视口并经 InteractionController 平移。小地图与 canvas.minimap-side 同处概览区, 收起后一起隐藏;地图内部的收起/适合屏幕按钮在悬停边缘浮出,收起动作经 宿主注入的 onCollapse 交给宿主保存状态。没有贡献时不占高度。

"canvas.minimap": {
render: ComponentType<CanvasSlotProps & {
onCollapse?: () => void;
}>;
};

关联类型:CanvasSlotProps

canvas.minimap-side

小地图两侧的紧凑内容(2026-10-26),例如右侧的缩放条。

只在小地图概览区展开时渲染;缺省放在右侧,left 排在小地图之前。

"canvas.minimap-side": {
position?: "left" | "right";
render: ComponentType<CanvasSlotProps>;
};

关联类型:CanvasSlotProps

canvas.minimap-top

小地图面板上方的独立概览控件。

"canvas.minimap-top": {
render: ComponentType<CanvasSlotProps>;
};

关联类型:CanvasSlotProps

canvas.node-action

通用「选中节点操作」横条的动作贡献 。

宿主在单选图片/视频/model3d 时渲染顶部独立横条并按 order 排列贡献的动作;下载由宿主自己 贡献。宿主只做通用布局/pointer 隔离/尺寸测量,MUST NOT import 扩展实现或按业务 ID 分支。

"canvas.node-action": NodeActionContribution;

关联类型:NodeActionContribution

canvas.node-drop

通用 extension 节点复制 Drop 接收。

拖动一批来源节点在 pointerup 落在某类型的纯模型扩展节点范围内时,宿主按贡献把释放委托给 extension;extension 自行读取画布、规划和提交(经通用 canvasCommands)。返回 true 表示 已消费本次释放(来源节点回位、不提交移动)。宿主只按通用 nodeType 命中与 slot 分派, MUST NOT import 任何具体业务收集/项目实现。

"canvas.node-drop": {
dropLabel?: string;
nodeType: string;
matchesTarget?: (input: {
canvas: import("@woohaa3/contracts").ServerCanvas;
targetNodeId: string;
}) => boolean;
acceptsSources?: (input: {
canvas: import("@woohaa3/contracts").ServerCanvas;
targetNodeId: string;
sourceNodeIds: readonly string[];
}) => boolean;
onDrop: (input: {
canvas: import("@woohaa3/contracts").ServerCanvas;
targetNodeId: string;
sourceNodeIds: readonly string[];
point: {
x: number;
y: number;
};
}) => boolean;
onPreview?: (input: {
canvas: import("@woohaa3/contracts").ServerCanvas;
targetNodeId: string;
sourceNodeIds: readonly string[];
}) => string | null;
};

关联类型:ServerCanvas

canvas.node-template

通用扩展节点模板。

扩展声明一个通用宿主节点的创建项:宿主据此在 section(缺省「创作工具」)插入菜单项, 选中时用 createNodeData() 产出的自包含 nodeData 创建 nodeType 节点。宿主只按通用 节点契约处理,不 import 任何具体扩展内容,也不出现业务插件专属 node type 或分支; nodeType 的合法性由 canonical 规范化与 reducer 校验。拉线创建时模板不作为连线目标(排除)。

"canvas.node-template": {
icon?: ComponentType<{
className?: string;
}>;
nodeType: string;
label: string;
section?: string;
order?: number;
createNodeData: (context: ContextMenuContext) => import("@woohaa3/contracts").CanvasNodeData | undefined;
};

关联类型:ContextMenuContext · CanvasNodeData

canvas.overlay

"canvas.overlay": {
render: ComponentType<CanvasSlotProps>;
};

关联类型:CanvasSlotProps

canvas.selection-action

多选动作横条的动作贡献 。

宿主在选中 ≥2 个节点时渲染顶部独立横条(锚定选区包围盒),按 order 排列贡献的动作;横条由 Bevy 绘制、Rust 命中。宿主只做通用布局/命中派发/尺寸测量,MUST NOT import 扩展实现或按业务 ID 分支。

"canvas.selection-action": SelectionActionContribution;

关联类型:SelectionActionContribution

canvas.toolbar

"canvas.toolbar": {
render: ComponentType<CanvasSlotProps>;
};

关联类型:CanvasSlotProps

canvas.toolbar-action

右下角控件面板里的图标动作。

tone: "primary" 用强调色实底表达面板主操作(如 AI 助手);顺序仍按 priority 升序。

"canvas.toolbar-action": {
label: string;
icon: ComponentType<{
className?: string;
}>;
tone?: "primary";
tooltip?: ComponentType<{
children: ReactNode;
}>;
onActivate: () => void;
};

canvas.toolbar-status

工具栏状态位置的紧凑读数;宿主保留同步状态气泡与色调,采用首个可用贡献。

"canvas.toolbar-status": {
wrapsStatus?: boolean;
render: ComponentType<CanvasSlotProps & {
renderStatus: (readout: ReactNode, details: ReactNode) => ReactNode;
}>;
};

关联类型:CanvasSlotProps

canvas.topbar

画布左上角顶栏。

宿主用一个固定的 flex 行承载贡献,按 priority 从左到右排列:低 priority 在左。 与 canvas.overlay 的差别是不做各自绝对定位,便于「当前用户」与画布切换器相邻。

"canvas.topbar": {
render: ComponentType<CanvasSlotProps>;
};

关联类型:CanvasSlotProps

canvas.topbar-status

窗口顶栏右侧的紧凑读数(Tauri 横栏)。

与 canvas.toolbar-status 的区别是归属:顶栏读数是窗口装饰的一部分,在概览与节点聚焦 编辑时都常驻,渲染在横栏靠右(画布控件之后、窗口按钮之前),悬停气泡向下展开; 工具栏读数只在右下角控件面板里、气泡向上展开。贡献方按运行宿主自行二选一 (例如开发性能面板在桌面进入顶栏、在浏览器留在工具栏),宿主不按扩展 ID 分支。

两个位置共用同一份气泡实现:宿主注入 renderStatus,贡献不各自实现 tooltip。

"canvas.topbar-status": {
wrapsStatus?: boolean;
render: ComponentType<CanvasSlotProps & {
renderStatus: (readout: ReactNode, details: ReactNode) => ReactNode;
}>;
};

关联类型:CanvasSlotProps

dialog.renderer

"dialog.renderer": {
dialogId: string;
render: DialogRenderer;
};

关联类型:DialogRenderer

execution.prompt-skill

执行面板「快捷改写」的提示词技能实现 。

宿主把首个可用贡献接到节点执行面板的快捷改写菜单:用户选中一项后调用 rewrite, 把返回的提示词写回当前草稿。草稿所有权在宿主,扩展不得直接写画布或草稿 store。 没有可用贡献时菜单保留既有「未接入提示词工具插件」提示。

"execution.prompt-skill": {
rewrite: (input: {
skill: {
id: string;
label: string;
description?: string;
};
prompt: string;
canvasId: string;
nodeId: string;
taskKind: string;
}) => Promise<{
prompt: string;
} | {
error: string;
}>;
};

input.drop

"input.drop": {
handle: (event: DragEvent) => boolean | void | Promise<void>;
canAccept?: (event: DragEvent) => boolean;
};

input.paste

"input.paste": {
handle: (event: ClipboardEvent) => boolean | void | Promise<void>;
};

provider-credentials.top

"provider-credentials.top": {
render: ComponentType<{
requestClose?: () => void;
}>;
};

settings.plugin-config

设置弹窗「插件详情」里的扩展自带设置面板 。

声明了 settingsPanel metadata 的站点扩展由设置按需加载其设置贡献;贡献按 pluginId 归到对应插件详情。宿主不 import 具体扩展实现;面板只取得 requestClose(语境为返回列表) 与 reportEditState(dirty/pending 汇总)。

"settings.plugin-config": {
pluginId: string;
render: ComponentType<SettingsPanelRenderProps>;
};

关联类型:SettingsPanelRenderProps