跳到正文
QuireKit
插件文档
Alpha · API 持续演进
图形与数据查看 Markdown ↗

DataView · 数据视图

保存可移植数据视图文档。交互渲染、工作区和布局注册由宿主注入,单独安装不会自动出现完整数据表格产品。

保存可移植数据视图文档。交互渲染、工作区和布局注册由宿主注入,单独安装不会自动出现完整数据表格产品。

@quirekit/extension-data-view · MIT

编辑器适用范围

层次:共享文档能力

编辑器状态所需装配与边界
Classic需适配ClassicDataView — 共享扩展只定义内容与宿主端口。使用下列 Classic 适配入口接入工作区和产品交互,不要同时安装共享扩展与其同名适配实现。
Block直接支持createBlockEditorPreset — createBlockEditor 默认预设已装配此能力。通过 preset 中对应子项配置;图形编辑使用预设注入的工作区,宿主仍负责保存和资源。不要重复安装同名扩展。

“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。

接入

sh

在创建 Editor 时放入 extensions。挂载容器、视图和保存由宿主提供,见快速开始。

ts

安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。

按编辑器接入

以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。

Classic · 需适配

共享扩展只定义内容与宿主端口。使用下列 Classic 适配入口接入工作区和产品交互,不要同时安装共享扩展与其同名适配实现。

ClassicDataView
ts

配置

下面是扩展自身的默认选项。预设可以覆盖这些值;它们不等于当前文档属性。配置方法见配置插件。

render

宿主渲染接口。图形扩展生成与源码匹配的静态预览;DataView 使用节点视图渲染接口。

类型:QuireNodeViewRenderer | null

默认:null

open

打开捕获目标的编辑工作区,返回可释放的界面任务。异步提交时仍需校验原目标。

类型:((request: DataViewEditRequest, editor: QuireEditor) => { close(): void; }) | null

默认:null

layouts

返回宿主提供的布局 provider 注册,供数据视图参与当前引擎排版。

类型:(() => readonly QuireLayoutProviderRegistration[]) | null

默认:null

命令与运行方式

以下命令由此扩展直接提供,均在当前 Editor 上调用。命令是否可用由已安装 schema、当前选区与保护策略决定;可以先用 editor.can() 查询。

命令参数签名
insertDataViewinsertDataView(input: DataViewInsertion)
replaceDataViewreplaceDataView(input: DataViewReplacement)

这里只展示参数签名。接界面时见命令与控件,正文变更继续经过同一事务与历史。

下一步

返回全部插件,或阅读配置插件区分配置、文档属性与命令。

自己定义能力时见扩展开发;搭建完整宿主时见构建产品。

QuireKitQuireKit · Core、插件与 Classic 文档