跳到正文
QuireKit
Core 开发文档
Alpha · API 持续演进

完整工作区参考

按文件用途查阅工作区、文档模型、扩展和文件操作的完整实现。

本页供你在完成教程后查阅完整实现。第一次接入请从建立第一个编辑器开始;需要某一项能力时,按下面的文件分工找到对应实现即可。

文件各负责什么

文件用途对应教程
product/standalone.ts在普通 Vue 应用里启动工作区,返回卸载函数建立工程
product/workspace.vue组合工具栏、文件按钮和编辑区域连接界面
product/runtime.ts创建 Editor,连接 View 与宿主尺寸挂载 View
product/assembly/generic.ts配置普通文章和提示组文档模型
product/assembly/word.ts配置 Word 预设和匹配的初始文档文档模型
product/session.ts更新按钮状态,协调编辑、保存和加载连接界面
product/files/repository.ts把备份写入浏览器存储保存和文件
product/files/backup.ts验证备份版本、节点和属性保存和文件
product/files/docx.ts按需加载 Word 转换并处理真实字节保存和文件
product/feature/*提示组的节点、命令、布局和选区内容扩展
product/types.ts工作区内部共享类型各模块的输入和输出
shared/download.ts将生成的文件交给浏览器下载保存和文件

在自己的工程中运行

完整工作区使用 Vue、@quirekit/core、@quirekit/starter-kit、@quirekit/view、@quirekit/view-engine、@quirekit/ui 和 @quirekit/unocss-preset。Word 版本另需 @quirekit/classic-docx 与 @quirekit/extension-text-style;商业包的分发范围见支持与许可。使用实际取得的同批次版本。

将文件选择器中的 product/ 和 shared/ 按原相对路径放入 src/examples/。Vite 开启 Vue 与 UnoCSS 插件,UnoCSS 使用 defineQuireKitUnoConfig(),并扫描 ./src/**/*.{vue,ts}。入口导入 uno.css;工作区已导入 View 的结构样式。

src/main.tsts

mountDocumentProduct() 接收页面中已有的元素,并返回释放函数。它同时管理 Vue 工作区和编辑器的创建与销毁;在应用退出或热更新时调用释放函数。

完整文件

选择一个文件,再点箭头展开。复制操作始终复制当前文件的完整原文;其他本地依赖都保留在文件列表中。

product/standalone.tsts
QuireKitQuireKit · Core、插件与 Classic 文档