Skip to content

Latest commit

 

History

History
131 lines (108 loc) · 9.89 KB

File metadata and controls

131 lines (108 loc) · 9.89 KB

文档索引

产品设计

文档 用途
product/object-semantics-and-selection.md Office 对象语义、识别可信度、四级选择交互与不可见行为选择
product/object-reference-and-selection-technical-design.md 统一对象引用、格式定位器、命中与解析、Surface API 和技术实施顺序

使用者文档

文档 用途
guide/getting-started.md 选包、安装、样式、输入和生命周期
guide/docx.md DOCX 查看、编辑和 Runtime
guide/xlsx.md XLSX 查看器、控制器和可选功能
guide/pdf.md PDF 来源、属性、事件和 Runtime
guide/pptx.md PPTX 纵向浏览、Surface 事件、播放和自定义播放器
guide/reference-selection.md 四种 Surface 的统一选择模式、确认事件、expose 与宿主状态边界
guide/surface-migration-guide.md 接入 0.5.3 最小 Surface 与手势缩放指南
components/README.md 推荐高层组件与基础 UI 组件
api/README.md 组合函数、Runtime 和核心 API 导航
composables/README.md DOCX、XLSX 和 PPTX 组合函数手册
custom-components/README.md 自定义工具栏、状态区、PPTX Surface 和播放器指南
api/public-api-contract.md 精确导出、错误码、弃用和兼容合同

当前执行入口

Important

npm 稳定版仍为 0.5.4;九个公开包的当前源码候选版本为 0.6.0。跨格式引用合同、通用选择状态、基础选择控件、四格式阶段一适配器和统一 Surface 选择事件已经落地;确认后的引用集合、意图界面和 Agent 工作流由宿主负责。

文档 用途
architecture-review-and-target-design.md 目标架构、包边界、状态所有权和兼容约束
docx-viewer-controlled-surface-and-pagination-fix.md DOCX 受控文档面、分页切片、缩放测量、纸面主题和批注布局修复合同
surface-search-and-pdf-selection-design.md 四种 Surface 的统一搜索会话、Find Bar、精确定位,以及 PDF glyph 选择与交互优化设计
pdf-text-layer-issue.md 已废止的 PDF 透明 text layer 历史方案与失败复盘
unified-surface-api-design.md 统一 Surface API 设计——四个 surface 组件的边界、样式、事件、expose 合同
file-format-support-plan.md XLSX、DOCX、PPTX、PDF View 的文件格式支持范围、接入边界和实施顺序
plan/stabilization-roadmap.md 唯一任务顺序、依赖、状态和执行证据来源
end-to-end-blackbox-test-plan.md 用户侧黑盒用例、通过标准和发布暂停条件
upstream-parity-gap-audit.md DOCX/XLSX 与官方 Extend UI React 的固定基准、差异和收口状态
testing/agent-execution-runbook.md 正式构建、浏览器、真实压缩包和证据的执行步骤
api/public-api-contract.md 九个公开包的入口、类型、事件、错误、弃用和删除期限

格式扩展设计

文档 用途
pptx-development-guide.md PPTX 正式开发的目录边界、命令、补丁流程、素材规则和后续扩展入口
pptx-playback-implementation-design.md 当前正式实现入口:总体结构、包边界、对象身份、时间调度、属性轨道、切换和媒体设计
pptx-playback-api-design.md 第一版公开类型、文档会话、播放控制器和 Vue 组件接口
pptx-headless-api-design.md 两个最小 composable、PptxStage、状态所有权和兼容重构要求
pptx-playback-compatibility-and-acceptance.md 严格、近似、静态和无法解析的范围,以及素材、误差、浏览器和发布门槛
pptx-playback-acceptance-results.md 三浏览器、性能、内存、资源释放和工作区外压缩包消费的正式结果
pptx-playback-roadmap.md 已执行的正式开发顺序、每阶段任务和通过条件
pptx-playback-exploration-design.md 已完成的三段播放探索及代码验证记录,作为正式设计的证据
pptx-preview-playback-design.md 静态预览底座、早期选型和历史播放判断;冲突内容以正式实现设计为准

发布资料

文档 用途
../RELEASE_NOTES.md 0.5.40.2.0 发布记录
migration-0.3.md 0.2.0 升级到 0.3.0 并接入 PPTX
migration-0.2.md 0.1.x 升级到 0.2.0 的代码与资源迁移
testing/compatibility-matrix.md Node、Vue、Vite、TypeScript 和三种浏览器的声明与待验证矩阵

当前包状态

以下状态更新于 2026-07-14。九个公开包当前源码候选版本统一为 0.6.0,尚未替代 npm 稳定版 0.5.4

当前能力 源码状态
@arcships/office-interaction 提供跨格式引用、确认/取消事件、运行时校验、稳定序列化、候选导航、键盘解释器、几何与临时选择 reducer 0.6.0 候选
@arcships/docx-core 提供模型、布局、编辑命令、实例 Runtime、DOCX 基础引用适配,以及公开 Worker/WASM 入口 0.6.0 候选
@arcships/vue-docx 提供 DocxViewerDocxEditor、组合函数和公开样式入口 0.6.0 候选
@arcships/xlsx-core 提供工作簿、公式、图表/图片数据、基础引用适配、实例 Runtime,以及公开 Worker/WASM 入口 0.6.0 候选
@arcships/vue-xlsx 提供 XlsxViewer、控制器、公开样式,以及按需图表/地图/WebGL 入口 0.6.0 候选
@arcships/vue-pdf 提供 PDF 查看、翻页、缩放、旋转、缩略图、搜索、glyph 文字选择和基础引用适配 0.6.0 候选
@arcships/vue-ui 提供对象轮廓与区域框选择原语,以及上传、签名、缩略图、Find Bar 和版面等通用组件 0.6.0 候选
@arcships/pptx-core 提供 PPTX 列表/单页预览、对象身份与基础引用适配、播放模型、文档会话和浏览器控制器 0.6.0 候选
@arcships/vue-pptx 提供纵向 PptxViewerPptxStage Surface 事件、最小组合接口和公开样式 0.6.0 候选

@arcships/office-runtime 仍是私有工作区包,不属于公开安装清单。

当前发布流程从同一提交生成九个真实压缩包。所有公开包都会在工作区外安装并验证公开入口;PPTX 压缩包还会用浏览器实际打开文件和执行第一次单击动画。

测试与发布资料

文档 用途
testing/performance-baseline.md 已批准的性能环境、数值和比较规则
visual-acceptance-handoff.md 历史视觉口径和专项补充,不替代当前黑盒方案
shadcn-components-browser-acceptance.md 通用组件的专项浏览器检查
component-browser-verification-plan.md 组件浏览器验证补充计划

历史迁移资料

Warning

本节文件保存 2026-07-06 至 2026-07-07 的迁移分析。文件中的“当前状态”、donepending、旧目录、旧截图和旧行数都只代表当时情况,不能覆盖本页“当前执行入口”中的文档。

文档 历史用途
upstream-xlsx-feature-alignment.md XLSX 上游功能清单与最初迁移方案
xlsx-migration-architecture.md XLSX 模块化迁移设计
upstream-docx-feature-alignment.md DOCX 上游功能清单与最初迁移方案
docx-migration-architecture.md DOCX 模块化迁移设计
docx-editor-helpers-split-plan.md 旧编辑器辅助代码拆分计划
plan/README.md 2026-07-07 的历史迁移任务表
plan/analysis/migration-split.md 历史任务拆分分析
plan/tasks/ 历史任务文件
plan/reviews/ 历史局部审查记录
plan/backlog.md 非阻断历史记录

代码范围

packages/office-interaction/ 跨格式对象引用、选择事件与纯函数
packages/docx-core/      DOCX 核心与 Runtime
packages/vue-docx/       DOCX Vue 组件
packages/xlsx-core/      XLSX 核心与 Runtime
packages/vue-xlsx/       XLSX Vue 组件与按需渲染
packages/vue-pdf/        PDF Vue 组件
packages/vue-ui/         通用 Vue 组件
packages/pptx-core/      PPTX 模型、静态预览和正式播放核心
packages/vue-pptx/       PPTX Vue 浏览与演示组件
apps/demo/               正式黑盒消费页
tests/                   单元、组件、黑盒和外部消费测试
scripts/ci/              固定检查入口和证据编排