# drawboard-agent **Repository Path**: dxdbc/drawboard ## Basic Information - **Project Name**: drawboard-agent - **Description**: 方便 Agent 和 人 交互的图型画板。大幅提高沟通的效率。 - **Primary Language**: TypeScript - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-07-05 - **Last Updated**: 2026-09-05 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Drawboard 一个基于 TypeScript 和 Konva 的交互式图表编辑器核心引擎。 ## 简介 Drawboard 是一个用于创建和编辑 UML 图表(流程图、时序图、类图、组件图等)的 TypeScript 核心库。它提供了完整的命令系统、状态管理、历史记录、交互处理和自动布局功能。 ## 特性 - **多种图表类型**:支持流程图、时序图、类图、组件图、部署图、状态图、用例图等 - **命令系统**:基于 Command 模式的撤销/重做支持 - **交互工具**:拖拽、绘制、缩放、平移、框选、文本编辑、连线绘制 - **自动布局**:支持树形、网格、对称、列表等多种布局算法 - **DSL 导入/导出**:JSON 格式的图表序列化与反序列化 - **Prompt 生成**:支持 AI Agent 集成的语义化描述生成 ## 技术栈 - **语言**:TypeScript - **渲染**:Konva - **包管理**:pnpm ## 目录结构 ``` src/ ├── core/ # 核心引擎 │ ├── Engine.ts # 主入口 │ ├── State.ts # 状态管理 │ ├── EventBus.ts # 事件总线 │ ├── HistoryManager.ts # 历史管理 │ ├── commands/ # 命令实现 │ ├── interaction/ # 交互处理 │ │ └── handlers/ # 各种处理器 │ └── routing.ts # 连线路由算法 ├── elements/ # 图元渲染 │ └── ElementRenderer.ts ├── layouts/ # 布局算法 ├── dsl/ # DSL 解析/序列化 ├── prompt/ # Prompt 生成 └── renderer/ # 渲染器 ``` ## 安装 ### 作为项目依赖 ```bash # npm npm install drawboard # pnpm pnpm add drawboard # 或本地路径(开发阶段) pnpm add file:../path/to/drawboard ``` ### 浏览器直接引入 ```html ``` ### 本地开发 ```bash pnpm install ``` ## 开发命令 ```bash # 构建 pnpm build # 测试 pnpm test # Lint 检查 pnpm lint # 类型检查 pnpm typecheck ``` ## 快速开始 ### 完整 UI 模式(推荐) `DrawboardApp` 封装了完整的交互界面(工具栏、画布、ghost 拖拽、颜色面板、布局、tips),一行代码嵌入: ```html Drawboard
``` ### 底层引擎 API 若只需要核心引擎(无 UI),直接使用 Engine: ```typescript import { Engine, Parser, Serializer } from 'drawboard'; // 创建引擎实例 const engine = new Engine(); // 执行命令添加节点 const command = new AddNodeCommand({ id: 'node1', type: 'rect', x: 100, y: 100, width: 120, height: 60, label: '开始', }); engine.execute(command); // 导出为 DSL const dsl = Serializer.serialize(engine.getState()); // 从 DSL 导入 const state = Parser.parse(dsl); ``` ## 布局引擎 Drawboard 提供完整的自动布局支持: ```typescript // 自动检测布局类型并应用 const result = engine.autoLayout(); // 手动选择布局类型 const result = engine.autoLayout({ diagramType: 'hierarchy', direction: 'down', }); ``` 支持的布局类型: - **层级布局**:DOWN_TREE, RIGHT_TREE, LEFT_TREE, UP_TREE - **网格布局**:GRID - **对称布局**:LR_SYMMETRY, TB_SYMMETRY, DOWN_LIST_SYMMETRY - **列表布局**:DOWN_LIST_LEFT, DOWN_LIST_RIGHT, FREE ## 许可证 Apache-2.0