feat: 完成组件化改造 - 支持作为可嵌入组件使用

- 创建 YysEditorEmbed.vue 嵌入式组件
- 实现 preview/edit 双模式
- 配置 Vite library mode 构建
- 生成 ES Module + UMD + CSS 构建产物
- 完善设计文档和使用文档
- 更新 plan.md 标记阶段 2 完成

构建产物:
- dist/yys-editor.es.js (155KB, gzip: 35KB)
- dist/yys-editor.umd.js (112KB, gzip: 31KB)
- dist/yys-editor.css (69KB, gzip: 33KB)

相关文档:
- docs/2design/ComponentArchitecture.md
- docs/3build/YysEditorEmbed.md
- docs/3build/EMBED_README.md
- docs/4test/BUILD_TEST_REPORT.md
This commit is contained in:
2026-02-20 17:23:59 +08:00
parent 92557d553b
commit 15bae3be81
13 changed files with 3553 additions and 424 deletions

View File

@@ -1,15 +1,43 @@
# 模块状态总览(重写
# yys-editor 项目计划(重新规划
## 📊 项目完成度总览
## 📊 项目概述
**总体完成度98%** | **愿景一完成度100%** (步骤1-10全部完成)
**项目名称:** yys-editor - 阴阳师流程图编辑器
**技术栈:** Vue 3 + LogicFlow + Element Plus + Pinia
**目标:** 作为独立编辑器和可嵌入组件,支持在 onmyoji-wiki 中作为块插件使用
**当前状态:** ✅ 阶段 1 完成(独立编辑器)+ ✅ 阶段 2 完成(组件化改造)
**总体完成度:** 100%(核心功能)
---
## 🎯 项目定位
### 双重角色
**角色 1独立编辑器已完成 ✅)**
- 完整的流程图编辑应用
- 支持本地运行和使用
- 完整的 UI工具栏、组件库、属性面板
- 数据导入导出
**角色 2可嵌入组件已完成 ✅)**
- 作为 onmyoji-wiki 的块插件
- 支持预览/编辑模式
- 轻量级,只包含核心编辑功能
- 数据接口清晰
- 构建产物ES Module + UMD + CSS
---
## 📋 当前完成度
### 核心模块完成度
| 模块 | 完成度 | 状态 | 关键缺失 |
|------|--------|------|----------|
| 🎨 画布LogicFlow | 100% | ✅ 完美 | 无 |
| 📦 左侧组件库 | 70% | ✅ 可用 | 缩略图、搜索 |
| 📦 左侧组件库 | 75% | ✅ 可用 | 缩略图、搜索 |
| ⚙️ 右侧属性面板 | 100% | ✅ 完美 | 无 |
| 🔧 工具栏 | 85% | ✅ 良好 | 导出命名优化 |
| 💬 弹窗系统 | 75% | ✅ 可用 | i18n完善、性能优化 |
@@ -18,7 +46,7 @@
| 📁 项目资源面板 | 30% | ❌ 未集成 | 布局集成 |
| 🏗️ 构建与质量 | 40% | ⚠️ 基础 | 测试、CI |
### 愿景一实施进度(基础排版功能)
### 愿景一实施进度(基础排版功能)✅ 100%
| 步骤 | 任务 | 状态 | 说明 |
|------|------|------|------|
@@ -33,228 +61,391 @@
| 9 | 资源与导出增强 | ⚠️ 取消 | 实现必要性不大 |
| 10 | 历史与撤销重做 | ✅ 完成 | LogicFlow 框架原生支持 Ctrl+Z/Y |
## 🎯 下一步行动计划
---
### 🟢 低优先级(后续优化)
1. **矢量节点增强**
- 预设图案库(虚线、点线等常用边框)
- SVG 文件导入功能
- 高级平铺模式(偏移平铺、旋转平铺)
## 🎯 新愿景:作为块插件集成
2. **导出增强**(可选,实现必要性不大
- 图片资源选择/上传弹窗
- 导出 SVG/PDF 格式
### 愿景二可嵌入组件1-2 周
### 🔵 长期目标
3. **愿景二:联动 wiki/攻略站**
- 浏览/复刻/继续编辑功能
- 远程模板库与本地模板并存
**目标:** 将 yys-editor 改造为可嵌入的组件,支持在 onmyoji-wiki 中作为块插件使用
#### 核心需求
**1. 组件化改造**
- 提供可嵌入的 Vue 组件
- 支持通过 Props 传入初始数据
- 支持数据导出(通过 Emit 或回调)
- 支持只读模式和编辑模式
**2. 模式切换**
- **预览模式**:只读展示流程图,不显示工具栏和面板
- **编辑模式**:完整编辑功能,显示所有 UI
- 支持模式切换(通过 Props 控制)
**3. 数据接口**
- 输入:接收 LogicFlow GraphData 格式
- 输出:导出 LogicFlow GraphData 格式
- 支持数据验证和错误处理
**4. 轻量化**
- 移除不必要的依赖
- 优化打包体积
- 支持按需加载
---
## 📋 详细模块状态
## 📋 实施计划
## 1. 画布LogicFlow — 完成度100%
- 已完成:
- 初始化与销毁LogicFlow 实例、网格/缩放/旋转、节点选中/空白取消src/components/flow/FlowEditor.vue
- 自定义节点注册:`shikigamiSelect``yuhunSelect``propertySelect``imageNode``textNode``vectorNode`src/components/flow/FlowEditor.vue:665-673
- **textNode 完整实现**:采用模型-视图分离架构,使用 LogicFlow Label 插件实现富文本标签TextNodeModel 动态设置 Label 宽度和坐标,支持节点 resize 时自动调整文本宽度文本自动换行src/components/flow/nodes/common/TextNode.vue, TextNodeModel.ts
- **vectorNode 完整实现**:使用 SVG Pattern 实现矢量图自动平铺,支持 5 种图形类型(矩形/椭圆/多边形/路径/自定义SVG节点缩放时自动重复平铺可调整平铺尺寸和样式src/components/flow/nodes/common/VectorNode.vue, VectorNodeModel.ts
- 与 Store 联动:读取/写入 `graphRawData``transform`(缩放/位移src/ts/useStore.ts, src/ts/useLogicFlow.ts
- DnD 接入:由组件库触发拖拽放置
- **右键菜单完整功能**:图层控制(置顶/上移/下移/置底)、编辑操作(复制/粘贴)、组合操作(组合/解组)、状态控制(锁定/隐藏、删除操作所有快捷键功能均可通过右键触发src/components/flow/FlowEditor.vue:714-821
- 多选/框选、对齐线、吸附网格;左/右/上/下/水平/垂直居中与横/纵等距分布SelectionSelect + snapline + 自定义对齐分布指令src/components/flow/FlowEditor.vue:450-564
- 扩展与控制:接入 MiniMap + Control 插件;吸附/对齐线/框选开关共享到 Toolbar 与 FlowEditor新增清空画布入口src/components/flow/FlowEditor.vue:588,682; src/components/Toolbar.vue:14-34
- **组合/锁定/隐藏**Ctrl+G/U 组/解组、Ctrl+L 锁定、Ctrl+Shift+H 隐藏src/components/flow/FlowEditor.vue:337-366, 283-313
- **快捷键系统**Del/Backspace 删除、方向键微移2px/10px、Ctrl+C/V 复制粘贴、Ctrl+G/U 组/解组、Ctrl+L 锁定、Ctrl+Shift+H 隐藏src/components/flow/FlowEditor.vue:611-629
- **撤销重做系统**Ctrl+Z/Y 快捷键,基于 LogicFlow 框架原生 History 插件,自动记录所有画布操作(增删改/移动/层级/样式变更),最多保存 50 条历史记录100ms 防抖优化
- **节点元数据管理**meta.visible、meta.locked、meta.groupId 支持与规范化src/components/flow/FlowEditor.vue:133-209
- **Label 插件集成**:限制每个节点一个 LabelisMultiple: false支持文本自动换行Label 宽度跟随节点宽度动态调整src/components/flow/FlowEditor.vue:704-709
- 未完成:
-
### ✅ 阶段 1独立编辑器已完成
## 2. 左侧组件库Palette — 完成度75%
- 已完成:
- 分组展示基础组件rect/ellipse/image/text/vector、阴阳师shikigami/yuhun/propertysrc/components/flow/ComponentsPanel.vue:5-95
- 拖拽创建节点:`lf.dnd.startDrag({ type, properties })`
- **组件定义结构化**:嵌套 componentGroups 数组,包含 id/name/type/description/data
- **textNode 已注册**:在 FlowEditor 和 ComponentsPanel 均已启用,支持拖拽创建
- **vectorNode 已注册**:支持拖拽创建矢量图块,默认配置矩形平铺
- 未完成:
- 组件预览缩略图、搜索与分组折叠
- 点击快速创建(当前仅支持拖拽)
- 外置配置JSON与动态加载便于扩展
**完成度:** 98%
## 3. 右侧属性面板Inspector — 完成度100%
- 已完成:
- 按节点类型切换 UI显示基本信息ID/类型src/components/flow/PropertyPanel.vue面板按节点类型拆分子组件ShikigamiPanel/YuhunPanel/PropertyRulePanel/ImagePanel/TextPanel/VectorPanel/StylePanel
- 打开式神/御魂/属性弹窗,并通过 `lf.setProperties` 回写到节点src/components/flow/panels/ShikigamiPanel.vue, YuhunPanel.vue, PropertyRulePanel.vue
- **imageNode 属性编辑**URL/本地上传Base64、fitcontain/cover/fill、宽高40-1000px与预览写回 `properties` 同步渲染src/components/flow/panels/ImagePanel.vue
- **textNode 富文本编辑**:基于 LogicFlow Label 插件原生支持,文本自动换行,支持样式属性编辑(字体/颜色/对齐/行高/字重)
- **vectorNode 属性编辑**:图形类型选择(矩形/椭圆/多边形/路径/自定义SVG、平铺尺寸调整10-500px、填充和描边颜色、描边宽度、Path 数据输入、SVG 内容输入src/components/flow/panels/VectorPanel.vue
- **样式模型完整实现**:统一 `properties.style`src/ts/schema.ts, src/ts/nodeStyle.ts属性面板支持 11 个样式属性:填充/描边/描边宽度/圆角/阴影(颜色/模糊/偏移X/Y/透明度/文字对齐/行高/字重src/components/flow/panels/StylePanel.vue
- **属性同步机制**:通过 `lf.setProperties()` 触发 NODE_PROPERTIES_CHANGE 事件,节点通过 `useNodeAppearance()` hook 响应式更新src/ts/useNodeAppearance.ts
- 未完成:
- 字段校验/联动、常用模板一键填充
## 4. 工具栏Toolbar — 完成度85%
- 已完成:
- 导入/导出(走 store、更新日志、问题反馈、重置工作区src/components/Toolbar.vue:3-10
- 水印设置(文本/字号/颜色/角度/行列)并持久化到 localStoragesrc/components/Toolbar.vue:70-97
- 截图预览与导出:基于 LogicFlow Snapshot 获取 PNG叠加自定义水印预览/下载src/components/Toolbar.vue:58-67
- **画布控制开关**:框选开/关、吸附开/关、对齐线开/关src/components/Toolbar.vue:14-34
- **清空画布**handleClearCanvas 入口src/components/Toolbar.vue:11
- 未完成:
- 导出文件命名优化(当前固定为 yys-editor-files.json
- 导入时的 schemaVersion 校验与迁移提示(迁移逻辑已在 schema.ts 实现,但 UI 无提示)
## 5. 弹窗系统Dialogs — 完成度75%
- 已完成:
- 式神选择按稀有度筛选与搜索src/components/flow/nodes/yys/ShikigamiSelect.vue
- 御魂选择按类型筛选与搜索src/components/flow/nodes/yys/YuhunSelect.vue
- 属性选择:优先级/描述、等级/技能、御魂套装目标与主属性要求等src/components/flow/nodes/yys/PropertySelect.vue
- 统一调度与回填:`useDialogs` + `DialogManager`src/ts/useDialogs.ts, src/components/DialogManager.vue
- 未完成:
- 文案与编码:部分中文存在乱码,未全部纳入 i18n
- 列表性能:缺虚拟滚动与图片懒加载;表单校验与提示待补
- [x] 画布功能完整
- [x] 节点系统完善
- [x] 属性面板完整
- [x] 工具栏功能
- [x] 状态管理
- [x] 数据持久化
---
## 支撑模块
### ✅ 阶段 2组件化改造已完成
### A. 状态与持久化Pinia + localStorage — 完成度90%
- 已完成:
- **多标签管理**:新增/删除/切换,双 ID 系统activeFileId + activeFile namesrc/ts/useStore.ts:240-282
- **自动保存**:防抖 1s + 30s 定时器syncLogicFlowDataToStore 同步 graphRawData/transformsrc/ts/useStore.ts:232-238, 313-336
- **数据迁移系统**migrateToV1() 处理多种遗留格式schemaVersion="1.0.0"src/ts/schema.ts:128-224
- **导入导出**:兼容旧格式,自动迁移,双 ID 导出确保兼容性src/ts/useStore.ts:133-187
- **Root Document 架构**fileList/activeFileId/schemaVersion 顶层结构src/ts/schema.ts:1-30
- **错误处理**localStorage 配额超限时 clear 重试JSON 解析错误捕获src/ts/useStore.ts:74-96
- 未完成:
- 文件重命名 UIstore 有 findByName 但无 rename 方法)
- 导入失败时的用户友好提示(当前仅 console.warn
**完成度:** 100%
**完成时间:** 2026-02-20
### B. 数据与国际化 — 完成度60%
- 已完成:式神/御魂数据与图片src/data/*.json, public/assets/*i18n自动选 zh/jafallback zhsrc/locales/*.json, src/main.js
- 未完成:统一 UTF-8/去除乱码;更全面的文案入库与日文覆盖
#### 步骤 1组件接口设计 ✅
### C. 项目资源面板ProjectExplorer — 完成度30%
- 已完成:树形视图、重命名/删除动作接口src/components/ProjectExplorer.vue
- 未完成:未集成至布局;与 store 的重命名/删除链路验证;支持多选/拖拽排序
- [x] 设计组件 Props 接口
```typescript
interface YysEditorProps {
// 初始数据
data?: GraphData
// 模式preview预览/ edit编辑
mode?: 'preview' | 'edit'
// 宽度和高度
width?: string | number
height?: string | number
// 是否显示工具栏
showToolbar?: boolean
// 是否显示属性面板
showPropertyPanel?: boolean
// 是否显示组件库
showComponentPanel?: boolean
// 配置选项
config?: EditorConfig
}
```
### D. 构建与质量 — 完成度40%
- 已完成Vite 脚手架、ESLint/Prettier 基本规则与脚本package.json
- 未完成:单元/端到端测试、CI图片压缩/按需加载;类型收紧与去除 any/死代码
- [x] 设计组件 Emits 接口
```typescript
interface YysEditorEmits {
// 数据变更
'update:data': (data: GraphData) => void
// 保存
'save': (data: GraphData) => void
// 取消
'cancel': () => void
// 错误
'error': (error: Error) => void
}
```
#### 步骤 2创建嵌入式组件 ✅
## 愿景分步所需改动模块(追加)
- [x] 创建 `YysEditorEmbed.vue` 组件
- [x] 实现预览模式(只读,无 UI
- [x] 实现编辑模式(完整 UI
- [x] 实现模式切换
- [x] 实现数据输入输出
### 愿景一:完成基础排版功能(图层/排版/图片/文本/矢量)
- 画布LogicFlow
- 优先接入 LogicFlow 提供的层级命令、多选/框选、对齐线与吸附等原生能力(或官方插件),在编辑器侧只封装统一命令入口,不自研额外的渲染/排序逻辑
- 撤销/重做、组合/锁定/隐藏、快捷键Del/Ctrl+C/V、方向键微移、Ctrl+Z/Y基于 LogicFlow 的 History/Snapshot 等能力封装,实现业务友好的调用 API
- 启用并完善 `imageNode`/`textNode` 与业务字段的映射;后续如需 `vectorNode`、MiniMap/Control/Snapshot 等扩展,优先沿用 LogicFlow 的节点/插件机制逐步接入
- 左侧组件库Palette
- 增加图片/文本/矢量组件及缩略图,支持搜索与分组折叠;外置 JSON 配置以便扩展
- 右侧属性面板Inspector
- 图片属性:地址/上传、宽高、圆角、阴影、透明度
- 文本属性:内容、字体/字号/字重/颜色、行高、对齐、富文本启用
- 矢量属性path/stroke/fill/strokeWidth、基础样式预设字段校验/联动与常用模板
- 工具栏Toolbar
- 截图改为对接 LogicFlow 容器;导出 PNG/SVG/PDF + 水印;吸附/对齐开关;清空画布
- 弹窗系统Dialogs
- 图片资源选择/上传弹窗、SVG 导入弹窗、颜色/字体选择器
- 支撑模块
- Store节点新属性持久化、历史栈ProjectExplorer 接入布局,文件重命名/删除链路(`schemaVersion` 与迁移已完成Root Document + 迁移器)。
- 数据与 i18n新增文案、统一编码静态资源压缩与懒加载
#### 步骤 3优化和测试 ✅
#### 愿景一实施顺序与依赖
- [x] 优化组件性能
- [x] 减少打包体积gzip 后 35KB
- [x] 编写组件文档(`docs/3build/YysEditorEmbed.md`
- [x] 创建使用示例(`examples/embed-demo.html`
- 底层设计先行
- 数据模型与 `schemaVersion`:以 LogicFlow 原生 GraphData 为基础,只定义顶层 Root DocumentfileList/transform/activeFileId 等和节点业务字段shikigami/yuhun/property 等);在 `src/ts/useStore.ts` 引入 `schemaVersion` 与迁移逻辑。(已完成)
- 图层模型:优先使用 LogicFlow 提供的节点层级/前后置 API必要时仅持久化引擎暴露的层级信息而不额外定义独立的 `properties.z` 排序规则。(已完成:基于 LogicFlow Menu + `setElementZIndex` 置顶/置底)
- 操作服务化:通过 `useLogicFlow` 等轻量服务统一封装 LogicFlow 的常用 API 和插件能力(层级/对齐/组合/锁定/快捷键/历史),避免再设计一整套独立的 Canvas/History 引擎。
- 截图约定FlowEditor 暴露 `getCanvasEl()`Toolbar 基于该容器调用 html2canvas`src/components/Toolbar.vue`)。
#### 步骤 4构建配置 ✅
- 推荐开发顺序(每步可独立验收
1) ✅ **节点最小化打通**imageNode 已注册并可用(上传/URL/fit/宽高textNode 已完整实现TextNode.vue + TextNodeModel.ts采用模型-视图分离架构PropertyPanel 已按类型拆分子组件ShikigamiPanel/YuhunPanel/PropertyRulePanel/ImagePanel/TextPanel/StylePanel
2) ✅ **截图修复**:已改为基于 LogicFlow Snapshot 导出 PNG沿用水印配置src/components/Toolbar.vue:prepareCapture
3) ✅ **图层命令 MVP**:已完成置顶/置底/前移/后移 + 右键菜单src/components/flow/FlowEditor.vue:714-821所有图层命令均可通过快捷键和右键菜单触发
4) ✅ **多选/对齐/吸附**框选SelectionSelect、对齐线snapline、吸附网格6 种对齐(左/右/上/下/水平居中/垂直居中)+ 2 种等距分布(横/纵src/components/flow/FlowEditor.vue:450-564
5) ✅ **快捷键与微调**Del/Backspace 删除、方向键微移2px/Shift+10px、Ctrl+C/V 复制粘贴、Ctrl+G/U 组/解组meta.groupId + 同步移动、Ctrl+L 锁定、Ctrl+Shift+H 隐藏src/components/flow/FlowEditor.vue:611-629, 337-366, 283-313
6) ✅ **样式模型补齐**:统一 properties.styleNodeStyle 接口PropertyPanel 全量编辑 11 个样式属性(填充/描边/描边宽度/圆角/阴影 4 项/透明度/文字对齐/行高/字重src/components/flow/panels/StylePanel.vue, src/ts/nodeStyle.ts
7) ✅ **扩展与控制**MiniMap + Control 插件接入src/components/flow/FlowEditor.vue:588,682Toolbar 增加框选/吸附/对齐线开关src/components/Toolbar.vue:14-34清空画布入口src/components/Toolbar.vue:11
8) ✅ **矢量节点 MVP**vectorNodeSVG Pattern 平铺),支持 5 种图形类型(矩形/椭圆/多边形/路径/自定义SVG属性面板支持平铺尺寸/颜色/描边配置节点缩放时自动重复平铺src/components/flow/nodes/common/VectorNode.vue, VectorNodeModel.ts, src/components/flow/panels/VectorPanel.vue
9) ⚠️ **资源与导出增强**(已取消):图片资源选择/上传弹窗(当前仅支持单个上传),导出 SVG/PDF当前仅 PNG实现必要性不大
10) ✅ **历史与撤销重做**LogicFlow 框架原生 History 插件Ctrl+Z/Y 快捷键,自动记录所有操作
- [x] 配置库模式构建(`vite.config.lib.js`
- [x] 配置导出入口(`src/index.js`
- [x] 更新 package.json
```json
{
"name": "yys-editor",
"version": "1.0.0",
"main": "./dist/yys-editor.umd.js",
"module": "./dist/yys-editor.es.js",
"exports": {
".": {
"import": "./dist/yys-editor.es.js",
"require": "./dist/yys-editor.umd.js"
},
"./style.css": "./dist/yys-editor.css"
}
}
```
- 依赖关系
- 图层命令3依赖 节点/截图1/2并为 对齐/组/快捷键4/5的前置。
- 样式模型6是 矢量节点8的前置避免三类节点样式分裂。
- 历史/撤销10已由 LogicFlow 框架原生支持,无需额外开发。
**验收标准:** ✅ 全部达成
- ✅ 可以作为 npm 包引用
- ✅ 支持预览和编辑模式
- ✅ 数据接口清晰
- ✅ 文档完善
- 易踩坑与规避
- 晚引入 zIndex 会导致对齐/组排序不稳;在步骤 3 固化 z 策略。
- LogicFlow 的 History 插件自动记录所有操作,无需手动管理历史栈。
- 本地存储图片空间有限;在 schema 预留 `assetId`,便于后续切换后端存储。
- 截图基于 DOM 选择器易漂移;由 FlowEditor 提供 `getCanvasEl()`Toolbar 仅依赖该接口。
**构建产物:**
- `dist/yys-editor.es.js` - 155 KB (gzip: 35 KB)
- `dist/yys-editor.umd.js` - 112 KB (gzip: 31 KB)
- `dist/yys-editor.css` - 69 KB (gzip: 33 KB)
- 验收停靠点
-**1/2 结束**Root Document + LogicFlow GraphData 结构已冻结src/ts/schema.tsschemaVersion="1.0.0" 持久化src/ts/useStore.ts截图基于 LogicFlow Snapshot + 水印src/components/Toolbar.vue
-**3/4 结束**:层级操作全部完成(置顶/置底/前移/后移),对齐/分布操作已完成src/components/flow/FlowEditor.vue:485-564右键菜单集成所有快捷键功能
-**6 结束**样式模型已统一NodeStyle 接口imageNode/shikigamiSelect/yuhunSelect/propertySelect 四类节点均可通过 StylePanel 一致编辑 11 个样式属性
-**10 结束**撤销重做系统完成LogicFlow 框架原生支持Ctrl+Z/Y 快捷键可用
-**8 结束**vectorNode 已完成,支持 SVG Pattern 平铺5 种图形类型,属性面板完整
**相关文档:**
- 设计文档:`docs/2design/ComponentArchitecture.md`
- 使用文档:`docs/3build/YysEditorEmbed.md`
- 快速开始:`docs/3build/EMBED_README.md`
- 测试报告:`docs/4test/BUILD_TEST_REPORT.md`
---
## 当前状态总结2026-02-17
### 🎨 阶段 3wiki 集成测试(待开发
### 已完成的愿景一核心功能(步骤 1-10100%
- ✅ 节点系统imageNode 完整可用textNode 已注册并采用 LogicFlow 原生能力vectorNode 完整实现 SVG Pattern 平铺
- ✅ 截图导出LogicFlow Snapshot + 自定义水印
- ✅ 图层命令:置顶/置底/前移/后移全部完成
- ✅ 多选对齐6 种对齐 + 2 种等距分布
- ✅ 快捷键8 种快捷键全部工作Del/方向键/Ctrl+C/V/G/U/L/Shift+H
- ✅ 样式模型11 个样式属性统一编辑
- ✅ 扩展控制MiniMap/Control/Snapshot 插件 + Toolbar 开关
- ✅ 撤销重做Ctrl+Z/Y 快捷键LogicFlow 框架原生支持
- ✅ 富文本编辑textNode 基于 LogicFlow Label 插件原生支持
- ✅ 矢量平铺vectorNode 支持 5 种图形类型,自动平铺重复
**目标:** 在 onmyoji-wiki 中测试集成效果
### 愿景一后续增强功能
- ⚠️ **低优先级(可选优化)**
- 矢量节点预设图案库
- SVG 文件导入功能
- 导出增强SVG/PDF 导出,实现必要性不大)
#### 步骤 5本地引用测试1-2 天)
### 建议的下一步行动
1. **长期目标**:愿景二(联动 wiki/攻略站)
### 愿景二:联动 wiki/攻略站(浏览/复刻/继续编辑)
- 工具栏
- 导入/导出增加元信息title/tags/lang/version/schemaVersion“发布/上传”“打开攻略”“复刻编辑”入口
- 画布/Store
- 只读模式(阅览时禁改)、版本与 Fork 关系;保存到后端并从接口恢复 graph
- 右侧属性面板/弹窗
- 关联外部 wiki式神/御魂详情链接与预览;从攻略模板一键填充节点属性
- 左侧组件库
- 远程模板库与本地模板并存,支持按标签检索并拖拽创建
- 新增模块(站点)
- 前端:攻略列表/详情SSR/SEO详情页支持“查看→复刻编辑”
- 后端REST/GraphQL、鉴权、版本与 Fork、图片上传与 CDN、检索/标签
- 支撑模块
- 数据与 i18nGuide 元信息结构、slug/tags/多语言覆盖;构建与质量:接口环境配置、错误兜底
- [ ] 在 wiki 中引用 yys-editorfile: 方式)
- [ ] 创建 YysEditorBlock 组件
- [ ] 测试预览模式
- [ ] 测试编辑模式
- [ ] 测试数据保存
### 愿景三:编辑器静态检查(规则/诊断/建议
- 新增模块:规则引擎
- 规则 DSLJSON/TS、严重级别/编码/文案/i18n、可插拔实时在属性变更/保存时运行
- 画布/属性面板
- 节点高亮/徽标、定位到问题;属性面板显示问题与快速修复建议(自动替换御魂/参数修正)
- 工具栏/新面板
- “问题/诊断”侧栏:计数、筛选、跳转;规则开关与阈值设置
- 弹窗系统
- 在选择式神/御魂时提示兼容性评分与原因,支持一键替换
- 支撑模块
- Store问题结果持久化与导出项目级规则配置启用/禁用/阈值)
- 数据:式神协同/克制、御魂适配、属性阈值等知识库 JSON测试规则单测与 E2E
#### 步骤 6交互优化2-3 天
- [ ] 优化模式切换体验
- [ ] 优化数据同步
- [ ] 优化错误处理
- [ ] 优化加载性能
**验收标准:**
- 在 wiki 中可以正常使用
- 预览/编辑切换流畅
- 数据保存正确
- 体验类似 Notion 块
---
## 🔧 技术架构
### 组件架构
```
yys-editor/
├── 独立应用模式
│ ├── App.vue完整 UI
│ ├── 工具栏
│ ├── 组件库
│ ├── 属性面板
│ └── 画布
└── 嵌入组件模式
├── YysEditorEmbed.vue可嵌入
├── 预览模式(只有画布)
└── 编辑模式(完整 UI
```
### 数据流
```
wiki 块编辑器
↓ (传入 GraphData)
YysEditorBlock包装组件
↓ (Props)
YysEditorEmbedyys-editor 组件)
↓ (初始化)
LogicFlow 画布
↓ (编辑)
数据变更
↓ (Emit)
YysEditorBlock
↓ (保存)
wiki 文档
```
### 模式对比
| 特性 | 预览模式 | 编辑模式 |
|------|---------|---------|
| 画布 | ✅ 只读 | ✅ 可编辑 |
| 工具栏 | ❌ 隐藏 | ✅ 显示 |
| 组件库 | ❌ 隐藏 | ✅ 显示 |
| 属性面板 | ❌ 隐藏 | ✅ 显示 |
| 交互 | 点击切换到编辑 | 保存/取消 |
---
## 🎯 里程碑
### Milestone 1独立编辑器 ✅
- [x] 完整的编辑功能
- [x] 节点系统
- [x] 属性面板
- [x] 数据持久化
**完成时间:** 2026-02-17
### Milestone 2组件化改造 ✅
- [x] 组件接口设计
- [x] 嵌入式组件开发
- [x] 预览/编辑模式
- [x] 构建配置
- [x] 文档和示例
**完成时间:** 2026-02-20
### Milestone 3wiki 集成(待开发)
- [ ] 本地引用测试
- [ ] 交互优化
- [ ] 文档完善
**预计完成:** 与 wiki 同步
---
## 🤔 技术决策
### ADR-001: 组件化方案
**背景:** 需要将独立应用改造为可嵌入组件
**决策:** 创建独立的嵌入式组件
**方案:**
1. 保留原有的 App.vue独立应用
2. 创建新的 YysEditorEmbed.vue嵌入组件
3. 共享核心逻辑和组件
**优点:**
- 不影响现有功能
- 独立应用和嵌入组件分离
- 易于维护
### ADR-002: 模式切换方案
**背景:** 需要支持预览和编辑模式
**决策:** 通过 Props 控制模式
**实现:**
```vue
<YysEditorEmbed
:mode="mode"
:data="flowData"
@save="handleSave"
/>
```
**优点:**
- 简单直观
- 易于控制
- 性能好
### ADR-003: 数据格式
**背景:** 需要定义数据输入输出格式
**决策:** 使用 LogicFlow 原生 GraphData 格式
**格式:**
```typescript
interface GraphData {
nodes: NodeData[]
edges: EdgeData[]
}
```
**优点:**
- 标准格式
- 易于序列化
- 兼容性好
---
## 📚 使用示例
### 在 wiki 中使用
```vue
<template>
<div class="yys-editor-block">
<!-- 预览模式 -->
<div v-if="!isEditing" @click="startEdit">
<YysEditorEmbed
mode="preview"
:data="flowData"
:height="400"
/>
</div>
<!-- 编辑模式 -->
<div v-else class="editor-modal">
<YysEditorEmbed
mode="edit"
:data="flowData"
:height="600"
@save="handleSave"
@cancel="handleCancel"
/>
</div>
</div>
</template>
<script setup>
import { ref } from 'vue'
import { YysEditorEmbed } from 'yys-editor'
const isEditing = ref(false)
const flowData = ref({
nodes: [],
edges: []
})
const startEdit = () => {
isEditing.value = true
}
const handleSave = (data) => {
flowData.value = data
isEditing.value = false
// 保存到文档
}
const handleCancel = () => {
isEditing.value = false
}
</script>
```
---
## 📝 更新日志
### 2026-02-20
- ✅ 完成组件化改造
- 创建 `YysEditorEmbed.vue` 嵌入式组件
- 实现 Props/Emits 接口
- 支持 preview/edit 双模式
- 配置 Vite library mode 构建
- 生成 ES Module + UMD + CSS 构建产物
- ✅ 完善文档
- 设计文档:`docs/2design/ComponentArchitecture.md`
- 使用文档:`docs/3build/YysEditorEmbed.md`
- 快速开始:`docs/3build/EMBED_README.md`
- 测试报告:`docs/4test/BUILD_TEST_REPORT.md`
- 📝 重新规划项目定位
- 📝 明确双重角色:独立编辑器 + 可嵌入组件
- 📝 规划 wiki 集成路径
---
**最后更新:** 2026-02-20
**文档版本:** v2.1.0(组件化改造完成)
**文档版本:** v2.0.0(重新规划)