@witlink/workflow 0.0.4 → 0.0.5

package/README.md

@@ -1,58 +1,69 @@
 ## @witlink/workflow 库介绍
-> 工作流模块提供一个页面级组件WfManagePage。
+
+> 工作流模块提供一个页面级组件 WfManagePage。
+
+- localStorage 需要存储一些必要的信息
+- locale 语言标志 zh_CN en_US fr_FR
+- Access-Token 登录令牌
+- userInfo 用户信息
+- menuInfo 菜单信息
 
 ### 如何使用@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
+  setLang, // 宿主切换多语言时调用此方法通知此模块,zh_CN、en_US、fr_FR
   // Page组件
-  WfManagePage,     // 流程模板定义
-} from '@witlink/workflow'
+  WfManagePage, // 流程模板定义
+} from "@witlink/workflow";
 ```
 
-+ 初始化
+- 初始化
 
 ```js
-import WitlinkWorkflow from "@witlink/workflow"
+import WitlinkWorkflow from "@witlink/workflow";
 
-const app = createApp(App)
+const app = createApp(App);
 app.use(WitlinkWorkflow, {
-  i18n,  // 宿主i18n对象
+  i18n, // 宿主i18n对象
   pinia, // 宿主pinia对象
-  tokenKey: 'pro__Access-Token',  // localStorage中存储token的key
-  timezone: 'Etc/GMT+8',  // 时区
   theme: {
-    colorPrimary: '#165dff',
+    colorPrimary: "#165dff",
   },
-}) 
+});
 ```
 
-+  切换多语言
+- 切换多语言
 
 ```js
-import { setLang } from "@witlink/workflow"
-setLang(lang)
+import { setLang } from "@witlink/workflow";
+setLang(lang);
 ```
-+ Page组件的使用
+
+- Page 组件的使用
+
 ```js
-import type { RouteRecordRaw } from 'vue-router'
-import { WfManagePage } from '@witlink/workflow'
-export const wfRoutes: RouteRecordRaw[]= [
+import type { RouteRecordRaw } from "vue-router";
+import { WfManagePage } from "@witlink/workflow";
+export const wfRoutes: RouteRecordRaw[] = [
   {
-    path: 'wfManage',
-    name: 'wfManage',
+    path: "wfManage",
+    name: "wfManage",
     component: WfManagePage,
   },
-]
+];
 ```
-+ 接口转发配置
+
+- 接口转发配置
+
 ```js
 // 在开发环境
 // vite.config.ts中
@@ -75,4 +86,4 @@ location /wfapi/ {
   proxy_pass  https://ip:port/; # 注意结尾的斜杠
   # 请求 /wfapi/user 会被转发到 http://ip:port/user
 }
-```
+```

package/dist/index.d.ts

@@ -11,9 +11,7 @@ export default _default;
 
 declare function install(app: App, options: WorkflowOptions): void;
 
-export declare function setLang(lang: string): void;
-
-export declare function setTimezone(timezone: string): void;
+export declare function setWorkflowLang(lang: string): void;
 
 export declare const WfManagePage: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
@@ -26,14 +24,6 @@ export declare interface WorkflowOptions {
      * 宿主pinia对象
      */
     pinia?: any;
-    /**
-     * 默认pro__Access-Token
-     */
-    tokenKey?: string;
-    /**
-     * 默认Etc/GMT+8
-     */
-    timezone?: string;
     theme?: {
         colorPrimary: string;
     } & Record<string, string>;