@witlink/workflow 0.0.1

package/README.md

@@ -0,0 +1,78 @@
+## @witlink/workflow 库介绍
+> 工作流模块提供一个页面级组件WfManagePage。
+
+### 如何使用@witlink/workflow
+##### 1. 安装@witlink/workflow
+
+```bash
+npm install @witlink/workflow
+```
+##### 2. 使用@witlink/workflow
+```js
+import WitlinkWorkflow, {
+  setLang,        // 宿主切换多语言时调用此方法通知此模块,zh_CN、en_US、fr_FR
+  setTimezone,    // 设置时区如 Etc/GMT+8
+  // Page组件
+  WfManagePage,     // 流程模板定义
+} from '@witlink/workflow'
+```
+
++ 初始化
+
+```js
+import WitlinkWorkflow from "@witlink/workflow"
+
+const app = createApp(App)
+app.use(WitlinkWorkflow, {
+  i18n,  // 宿主i18n对象
+  pinia, // 宿主pinia对象
+  tokenKey: 'pro__Access-Token',  // localStorage中存储token的key
+  timezone: 'Etc/GMT+8',  // 时区
+  theme: {
+    colorPrimary: '#165dff',
+  },
+}) 
+```
+
++  切换多语言
+
+```js
+import { setLang } from "@witlink/workflow"
+setLang(lang)
+```
++ Page组件的使用
+```js
+import type { RouteRecordRaw } from 'vue-router'
+import { WfManagePage } from '@witlink/workflow'
+export const wfRoutes: RouteRecordRaw[]= [
+  {
+    path: 'wfManage',
+    name: 'wfManage',
+    component: WfManagePage,
+  },
+]
+```
++ 接口转发配置
+```js
+// 在开发环境
+// vite.config.ts中
+ server: {
+    proxy: {
+      '/wfapi': {
+        target: '当前系统的接口代理地址', //目标url
+        changeOrigin: true, //支持跨域
+        secure: false, // 跳过 HTTPS 证书检查
+        rewrite: (path) =>
+            path.replace(new RegExp("^" + '/wfapi'), ""),
+      },
+    },
+  },
+```
+
+```bash
+# 配置nginx转发
+location /wfapi/ {
+  proxy_pass  https://ip:port/; # 注意结尾的斜杠
+  # 请求 /wfapi/user 会被转发到 http://ip:port/user
+}
+```