Skip to content

公开 API 导航 ​

API按接入任务组织,配合可执行源码示例。Editor另有从当前公开源码生成的完整签名索引;具体版本的类型声明仍是最终签名依据。

包职责参考
@skynote/editor编辑器装配与宿主门面Editor
@skynote/core文档、会话、事务与协议Core
@skynote/plugins-basic基础节点、交互与小地图基础插件
@skynote/renderer-leafer浏览器渲染适配Leafer

当前文档对应Beta目标版本,安装状态与限制见快速开始。

从哪里开始 ​

你要做的事入口
嵌入一个编辑器构造与生命周期
接自己的工具栏、选区或几何面板节点与选择、历史
接保存、导入、图片或导出文档与媒体
刷新UI或消费事务日志事件与释放
查询某个Editor方法的完整参数完整签名索引
开发平台中立插件插件上下文、输入作用域
新增业务节点节点定义、完整示例
接文字格式、剪贴板或分支样式基础交互API
接自己的小地图面板小地图API、使用指南

返回值与错误反馈 ​

创建节点等接口可能返回null;查询可能返回undefined;文档校验使用ParseResult;媒体任务按succeeded/cancelled/failed区分;图片导出可能抛错或拒绝Promise。不能统一通过“没有抛异常”判断所有命令已成功。

签名索引由类型AST提取,并在本地检查与CI流程中核对漂移;它覆盖成员及签名,不自动证明行为说明正确。参数默认、前置条件、失败行为与宿主职责在各专题单独说明。

高级插件的使用手册不代表已经提供公开分发API。脑图、表格、画笔和钢笔当前以插件介绍与体验为入口。

可组合的画布能力,从一个想法开始。