zs-bpmn-demo

0.0.1 • Public • Published

logo

Vite Vue Bpmn Process Editor

English | 中文

GitHub stars GitHub stars

项目简介

Vite Vue Bpmn流程编辑器,基于Bpmn.jsViteVue.js 3.x

实现了 Bpmn.js 和 Diagram.js 的 typescript 类型声明,typescript 可以用来在编辑器中编写代码。

React 项目也可以参考自定义插件和属性更新方式。

码云:https://gitee.com/MiyueSC/vite-vue-bpmn-process

🚀Tips:

Diagram.js 最近已经实现了 Type Declares 声明,具体请查看 Diagram.jstype-declarations 分支~

Bpmn.js 的 Type Declares 声明 目前已经加入到 bpmn-io 团队的任务面板中,但目前处于 积压状态

友情赞助

生活不易,猪猪叹气。如果对您有帮助,您可以请我喝杯咖啡。十分感谢 (毕竟这个项目还是写了几个月, typescript 部分实在是太难写了)~ ~ ~ ~

微信 支付宝

付费咨询联系微信:

wechat.png

也可关注公众号:MiyueFE 的前端圈

wechat.png

结构目录

|-- public
|-- src
|   |-- additional-functions                       扩展的事件函数方法,包括右键事件等
|   |-- additional-modules                         bpmn.js 自定义模块(扩展与重写)
|       |-- AutoPlace
|       |-- ContextPad
|       |-- Lint
|       |-- Palette
|       |-- PopupMenu
|       |-- Renderer
|       |-- Rules
|       |-- Translate
|   |-- bo-utils                                   businessObject 相关属性处理函数
|   |-- components                                 组件 与 bpmn.js 自定义模块
|       |-- common                                 公共组件
|       |-- Designer                               流程设计器
|       |-- Palette                                重写的 bpmn.js 的 Palette 组件
|       |-- Panel                                  重写的 bpmn.js 的 Panel 组件
|       |-- Setting                                项目配置表单组件
|       |-- Toolbar                                编辑器工具栏组件
|   |-- bpmn-icons                                 bpmn 对应的图标文件 svg
|   |-- config                                     项目配置文件
|   |-- moddle-extensions                          bpmn.js 扩展解析文件
|       |-- activiti.json                          
|       |-- bpmn.json                              bpmn 基础元素和属性配置
|       |-- camunda.json                           
|       |-- flowable.json                          
|       |-- miyue.json                             自定义扩展配置
|       |-- zeebe.json                             zeebe 表单配置
|   |-- store
|       |-- editor
|       |-- modeler
|   |-- styles
|       |-- camunda-penal.scss                     camunda 官方侧边栏样式
|       |-- context-pad.scss                       bpmn.js 上下文菜单样式(扩展部分)
|       |-- designer.scss                          流程设计器样式
|       |-- index.scss                             项目样式统一入口
|       |-- palette.scss                           bpmn.js 的 Palette 组件样式(扩展部分)
|       |-- panel.scss                             bpmn.js 的 Panel 组件样式(重写panel)
|       |-- setting.scss                           项目配置表单样式
|       |-- toolbar.scss                           编辑器工具栏样式
|   |-- utils
|       |-- EmptyXML.ts                            生成空的 XML 文件
|       |-- EventEmitter.ts                        事件发布订阅器
|       |-- files.ts                               文件相关操作
|       |-- index.ts                               常用工具函数
|       |-- Logger.ts                              控制台日志输出美化
|       |-- storage.ts                             本地存储操作
|       |-- tools.ts                               常用工具函数
|       |-- uuid.ts                                uuid 生成器
|   |-- App.vue
|   |-- main.ts
|   |-- env.d.ts
|-- types
|   |-- bpmn-moddle
|   |-- declares
|       |-- bpmn.d.ts                              bpmn.js 的类型声明文件
|       |-- bpmn-js-bpmnlint.d.ts                  bpmn.js lint 模块
|       |-- bpmn-js-token-simulation.d.ts          bpmn.js 流转模拟模块
|       |-- bpmn-moddle.d.ts                       bpmn.js 的 moddle 类型声明文件
|       |-- camunda-bpmn-moddle.d.ts               camunda 官方 moddle 类型声明文件
|       |-- diagram.d.ts                           diagram.js 的类型声明文件
|       |-- diagram-js-direct-editing.d.ts         diagram.js 的双击编辑类型声明文件
|       |-- didi.d.ts                              [Nikku - didi](https://github.com/nikku/didi/blob/master/lib/index.d.ts)
|       |-- moddle.d.ts                            moddle 的类型声明文件
|       |-- object-refs.d.ts                       
|   |-- editor
|-- LICENSE
|-- README.md
|-- tsconfig.json
|-- package.json
|-- vite.config.js

Activiti moddle json: https://github.com/Activiti/activiti-modeling-app/blob/master/projects/process-editor/src/services/activiti.json

当前功能

1. 工具栏

  • [x] 导入文件
  • [x] 导出文件(xml, bpmn, svg)
  • [x] 预览文件字符串(xml, json)
  • [x] 元素对其(垂直上中下、水平左中右)
  • [x] 缩放
  • [x] 撤销恢复与重做
  • [x] 扩展功能(流程模拟,小地图,快捷键提示,bpmn 事件查询)

2. 编辑器

  • [x] 自定义流程id与名称
  • [x] 可选流程引擎(camunda,activiti,flowable)
  • [x] 动态背景设置
  • [x] 自定义 PaletteProvider
  • [x] 自定义 Renderer
  • [x] 自定义 ContentPadProvider
  • [x] 自定义 Rules
  • [x] 自定义 ElementFactory
  • [x] 扩展右键菜单
  • [ ] 自定义 Overlays
  • [ ] 扩展 Tooltip
  • [ ] 部分元素高亮

3. 属性面板

  • [x] 基础信息(id, name, version, executable ...)
  • [x] 附件文档(documentation)
  • [x] 执行作业
  • [x] 异步配置
  • [x] 流程启动项
  • [x] 扩展属性
  • [x] 执行监听器
  • [x] 流转条件
  • [ ] 任务监听器
  • [ ] 任务多实例(会签、或签)

界面预览

img.png

img_1.png

img_2.png

img_3.png

img_4.png

img_5.png

img_6.png

Licence

This project is licensed under the Apache License 2.0 .

Readme

Keywords

none

Package Sidebar

Install

npm i zs-bpmn-demo

Weekly Downloads

0

Version

0.0.1

License

none

Unpacked Size

9.54 MB

Total Files

16

Last publish

Collaborators

  • babysbreathcccccc