lone-workflow

1.1.5 • Public • Published

lone-workflow

🔥 本项目基于 vuebpmn.io@7.0workflow-bpmn-modeler,实现 flowable 的 modeler 流程设计器

预览

20200930030243

安装

# 安装
yarn add lone-workflow

使用说明(最简demo)

<template>
  <div>
    <lone-workflow
      ref="refNode"
      :xml="xml"
      :users="users"
      :groups="groups"
      :categorys="categorys"
      :is-view="false"
      :flow-info="flowInfo"
      @save="save"
    />
  </div>
</template>

<script>
import LoneWorkflow from "lone-workflow";

export default {
  components: {
    LoneWorkflow,
  },
  data() {
    return {
      xml: "", // 后端查询到的xml
      users: [
        { name: "张三", id: "zhangsan" },
        { name: "李四", id: "lisi" },
        { name: "王五", id: "wangwu" },
      ],
      groups: [
        { name: "web组", id: "web" },
        { name: "java组", id: "java" },
        { name: "python组", id: "python" },
      ],
      categorys: [
        { name: "OA", id: "oa" },
        { name: "财务", id: "finance" },
      ],
      flowInfo: {
        name: '流程名称',
        key: '流程编码'
      }
    };
  },
  methods: {
    getModelDetail() {
      // 发送请求,获取xml
      // this.xml = response.xml
    },
    save(data) {
      console.log(data);  // { process: {...}, xml: '...', svg: '...' }
    },
  },
};
</script>

弹窗模式(ant-design-vue)

<template>
  <a-modal
    title="标题"
    width="100%"
    :visible="visible"
    destroyOnClose
    @cancel="handleCancel"
    @ok="handleOk"
    cancelText="关闭">
    <div>
      <lone-workflow
        ref="refNode"
        :xml="xml"
        :users="users"
        :groups="groups"
        :categorys="categorys"
        :is-view="false"
        :flow-info="flowInfo"
        @save="save"
      />
    </div>
  </a-modal>
</template>

<script>
  import LoneWorkflow from "lone-workflow";
  import { postAction } from "../../../api/manage";

  export default {
    name: 'LoneWorkFlowList',
    components: {
      LoneWorkflow
    },
    data() {
      return {
        visible: false,
        // 以下为流程数据
        xml: "", // 后端查询到的xml
        users: [
          {name: "张三", id: "zhangsan"},
          {name: "李四", id: "lisi"},
          {name: "王五", id: "wangwu"},
        ],
        groups: [
          {name: "web组", id: "web"},
          {name: "java组", id: "java"},
          {name: "python组", id: "python"},
        ],
        categorys: [
          {name: "OA", id: "oa"},
          {name: "财务", id: "finance"},
        ],
        // 接口传递数据
        id: '',
        // 右侧流程信息
        flowInfo: {
          name: '',
          key: ''
        }
      }
    },
    methods: {
      open(record) {
        this.id = record.id
        this.xml = record.arg2
        // 回显flow名称和key信息
        this.flowInfo.name = record.flowName
        this.flowInfo.key = record.flowKey
        this.visible = true;
      },
      close() {
        this.$emit('close');
        this.visible = false;
      },
      handleOk() {
        this.$refs.refNode.save()
      },
      handleCancel() {
        this.close()
      },
      save(data) {
        postAction('/flow/flowProcdef/saveXml', { id: this.id, arg2: data.xml }).then((res) => {
          if (res.success) {
            this.$message.success('保存成功!')
            this.visible = false
          }
        })
        // console.log(data);  // { process: {...}, xml: '...', svg: '...' }
      },
    }
  }
</script>

iframe 部署

如果你的项目是 jquery 或 react 类项目,可以通过 iframe 的方式集成该流程设计器

本仓库通过 github pages 部署了静态页面,使用 jsdelivr 做 cdn ,国内访问也非常快速,所以你可以直接集成本仓库的页面,因为全部白嫖了 github 的资源,没有自己建服务器维护,所以不用担心资源失效问题。

当然你也可以在 docs/lib 文件夹下下载对应的版本,进行本地部署。

集成方式如下(ps:可直接拷贝以下代码到一个html文件中试一下):

<!DOCTYPE html>
<html lang="en">
  <body>
    <iframe
      src="https://goldsubmarine.github.io/workflow-bpmn-modeler/cdn/0.2.8/"
      id="myFrame"
      frameborder="0"
      width="100%"
      height="800px">
    </iframe>

    <script>
      let myFrame = document.getElementById("myFrame");
      // 获取到流程详情
      window.addEventListener("message", (event) => {
        console.log(event.data); // { xml: 'xxx', img: 'xxx', process: {} }
      });
      myFrame.onload = () => {
        let postMsg = {
          xml: "", // 后端查询到的xml,新建则为空串
          users: [
            { name: "张三1", id: "zhangsan" },
            { name: "李四1", id: "lisi" },
            { name: "王五1", id: "wangwu" },
          ],
          groups: [
            { name: "web组1", id: "web" },
            { name: "java组1", id: "java" },
            { name: "python组1", id: "python" },
          ],
          categorys: [
            { name: "OA1", id: "oa" },
            { name: "财务1", id: "finance" },
          ],
          isView: false
        }
        // 设置初始化值
        myFrame.contentWindow.postMessage(postMsg, "*")
      }
    </script>
  </body>
</html>

关于定制

本组件对标的是 flowable 官方设计器,也就是实现 flowable 的 xml 规则标准,里面所用名词也都是官方文档中的专业术语。所以这个组件只是程序员在开发阶段,自己建模导出 xml 的工具,试图定制该建模器的行为都是不对的,不要把业务带到建模器中来!自己的业务应该另行开发增删改查来实现。

该组件未来也不会升级 UI 库和 vue。不管库是否兼容,通过 iframe 的方式集成建模器才是最简单正确的方式。

License

MIT

Copyright (c) 2020-present, charles

Package Sidebar

Install

npm i lone-workflow

Weekly Downloads

6

Version

1.1.5

License

MIT

Unpacked Size

10.6 MB

Total Files

42

Last publish

Collaborators

  • lazy-cat