cosey 0.9.3 → 0.9.5

package/README.md

@@ -68,5 +68,12 @@ Cosey 基于 element-plus 并补充了众多组件，意在使开发者更加专
 - 打包案例 `npm run build`
 - 打包文档 `npm run docs:build`
 - 部署案例和文档 `npm run cosey:deploy`
-- 暂存提交代码
 - 更新 `create-cosey` 中 `cosey` 包的版本
+
+## 推送代码流程
+
+- 暂存提交代码
+- 打标签 `npm run tag`
+- 生成更新日志 `npm run changelog`
+- 暂存、提交 changelog `git commit -a -m 'chore: changelog'`
+- 推送

package/components/form-group/form-group.api.d.ts

@@ -1,4 +1,4 @@
-import type { ExtractPropTypes, SlotsType, PropType } from 'vue';
+import type { ExtractPropTypes, SlotsType, PropType, VNodeChild } from 'vue';
 export declare const formGroupProps: {
     alignment: {
         type: PropType<"stretch" | "center" | "flex-start" | "flex-end">;
@@ -13,7 +13,10 @@ export declare const formGroupProps: {
         default: boolean;
     };
     title: {
-        type: (NumberConstructor | StringConstructor)[];
+        type: PropType<VNodeChild>;
+    };
+    tooltip: {
+        type: PropType<VNodeChild>;
     };
     borderStyle: {
         type: PropType<"none" | "solid" | "dashed" | "dotted">;
@@ -38,7 +41,7 @@ export declare const formGroupProps: {
         readonly default: "horizontal";
     };
     spacer: {
-        readonly type: PropType<import("vue").VNodeChild | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+        readonly type: PropType<VNodeChild | import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
             [key: string]: any;
         }>>;
         readonly required: false;
@@ -64,7 +67,9 @@ export declare const formGroupProps: {
 };
 export type FormGroupProps = ExtractPropTypes<typeof formGroupProps>;
 export interface FormGroupSlots {
-    default: {};
+    default?: {};
+    tooltip?: {};
+    title?: {};
 }
 export declare const formGroupSlots: SlotsType<FormGroupSlots>;
 export declare const formGroupEmits: {

package/components/form-group/form-group.api.js

@@ -17,7 +17,10 @@ const formGroupProps = {
     default: true
   },
   title: {
-    type: [String, Number]
+    type: null
+  },
+  tooltip: {
+    type: null
   },
   borderStyle: {
     type: String

package/components/form-group/form-group.d.ts

@@ -12,7 +12,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         default: boolean;
     };
     title: {
-        type: (NumberConstructor | StringConstructor)[];
+        type: import("vue").PropType<import("vue").VNodeChild>;
+    };
+    tooltip: {
+        type: import("vue").PropType<import("vue").VNodeChild>;
     };
     borderStyle: {
         type: import("vue").PropType<"none" | "solid" | "dashed" | "dotted">;
@@ -76,7 +79,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         default: boolean;
     };
     title: {
-        type: (NumberConstructor | StringConstructor)[];
+        type: import("vue").PropType<import("vue").VNodeChild>;
+    };
+    tooltip: {
+        type: import("vue").PropType<import("vue").VNodeChild>;
     };
     borderStyle: {
         type: import("vue").PropType<"none" | "solid" | "dashed" | "dotted">;

package/components/form-group/form-group.js

@@ -3,6 +3,7 @@ import { formGroupEmits, formGroupSlots, formGroupProps } from './form-group.api
 import { reactiveOmit } from '@vueuse/core';
 import stdin_default$2 from '../icon/icon.vue.js';
 import stdin_default$1 from './form-group.style.js';
+import { ElTooltip } from 'element-plus';
 import { useComponentConfig } from '../config-provider/config-provider.api.js';
 
 var stdin_default = defineComponent({
@@ -43,7 +44,7 @@ var stdin_default = defineComponent({
         "style": {
           borderStyle: isBordered.value ? props.borderStyle : void 0
         }
-      }, [props.title && createVNode("div", {
+      }, [(props.title || slots.title) && createVNode("div", {
         "class": [`${prefixCls.value}-title`, `is-${props.position}`]
       }, [createVNode("div", {
         "style": {
@@ -55,7 +56,16 @@ var stdin_default = defineComponent({
       }, [props.collapsible && createVNode(stdin_default$2, {
         "name": innerCollapsed.value ? "co:caret-up" : "co:caret-down",
         "size": "xl"
-      }, null), props.title])]), withDirectives(createVNode(resolveComponent("el-space"), mergeProps(spaceProps, {
+      }, null), props.title || slots.title?.(), (props.tooltip || slots.tooltip) && createVNode(ElTooltip, {
+        "placement": "top"
+      }, {
+        content: () => props.tooltip || slots.tooltip?.(),
+        default: () => createVNode(stdin_default$2, {
+          "name": "co:help",
+          "class": `${prefixCls.value}-title-icon`,
+          "size": "md"
+        }, null)
+      })])]), withDirectives(createVNode(resolveComponent("el-space"), mergeProps(spaceProps, {
         "style": {
           display: "flex",
           minWidth: 0

package/components/form-group/form-group.style.js

@@ -35,6 +35,11 @@ var stdin_default = getSimpleStyleHook("CoFormGroup", (token) => {
           insetInlineEnd: token.sizeMD,
           transform: "translateY(-50%)"
         }
+      },
+      [`${componentCls}-title-icon`]: {
+        marginInlineStart: token.marginXXS,
+        cursor: "pointer",
+        alignSelf: "center"
       }
     }
   };

package/components/form-group/index.d.ts

@@ -14,7 +14,10 @@ declare const _FormGroup: {
             default: boolean;
         };
         title: {
-            type: (NumberConstructor | StringConstructor)[];
+            type: import("vue").PropType<import("vue").VNodeChild>;
+        };
+        tooltip: {
+            type: import("vue").PropType<import("vue").VNodeChild>;
         };
         borderStyle: {
             type: import("vue").PropType<"none" | "solid" | "dashed" | "dotted">;
@@ -100,7 +103,10 @@ declare const _FormGroup: {
             default: boolean;
         };
         title: {
-            type: (NumberConstructor | StringConstructor)[];
+            type: import("vue").PropType<import("vue").VNodeChild>;
+        };
+        tooltip: {
+            type: import("vue").PropType<import("vue").VNodeChild>;
         };
         borderStyle: {
             type: import("vue").PropType<"none" | "solid" | "dashed" | "dotted">;
@@ -181,7 +187,10 @@ declare const _FormGroup: {
         default: boolean;
     };
     title: {
-        type: (NumberConstructor | StringConstructor)[];
+        type: import("vue").PropType<import("vue").VNodeChild>;
+    };
+    tooltip: {
+        type: import("vue").PropType<import("vue").VNodeChild>;
     };
     borderStyle: {
         type: import("vue").PropType<"none" | "solid" | "dashed" | "dotted">;

package/config/index.d.ts

@@ -47,6 +47,7 @@ export interface LayoutSlots {
     afterToggle?: () => VNodeChild;
 }
 type FilterRouteHandler = (route: RouteRecordRaw) => RouteRecordRaw | void | boolean | undefined | null;
+type DefineAuthorityHandler = (userInfo: Record<any, any>) => void | Promise<void>;
 export type CoseyOptions = {
     router?: CoseyRouterOptions & RouterConfig;
     persist?: PersistConfig;
@@ -57,7 +58,9 @@ export type CoseyOptions = {
     filterRoute?: {
         hook: () => FilterRouteHandler;
     } | FilterRouteHandler;
-    defineAuthority?: (userInfo: Record<any, any>) => void | Promise<void>;
+    defineAuthority?: {
+        hook: () => DefineAuthorityHandler;
+    } | DefineAuthorityHandler;
     components?: LayoutComponents;
     slots?: LayoutSlots;
 };
@@ -68,7 +71,7 @@ export interface GlobalConfig {
     site: RequiredSiteConfig;
     api: RequiredApiConfig;
     filterRoute: NonNullable<CoseyOptions['filterRoute']>;
-    defineAuthority?: CoseyOptions['defineAuthority'];
+    defineAuthority: NonNullable<CoseyOptions['defineAuthority']>;
     components: NonNullable<CoseyOptions['components']>;
     slots: NonNullable<CoseyOptions['slots']>;
 }

package/config/index.js

@@ -18,7 +18,7 @@ function provideGlobalConfig(app, options) {
     site = {},
     api = {},
     filterRoute = () => true,
-    defineAuthority,
+    defineAuthority = () => void 0,
     components = {},
     slots = {}
   } = options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cosey",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "基于 Vue3 + vite 的后台管理系统框架",
   "type": "module",
   "main": "index.js",

package/store/user.d.ts

@@ -12,7 +12,7 @@ export declare const useUserStore: import("pinia").StoreDefinition<"cosey-user",
     login: (data: any) => Promise<void>;
     getUserInfo: () => Promise<UserInfo | undefined>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void | undefined>;
+    setAuthorization: () => Promise<void>;
     addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
 }, "dynamicRoutes" | "userInfo" | "requestedUserInfo">, Pick<{
@@ -22,7 +22,7 @@ export declare const useUserStore: import("pinia").StoreDefinition<"cosey-user",
     login: (data: any) => Promise<void>;
     getUserInfo: () => Promise<UserInfo | undefined>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void | undefined>;
+    setAuthorization: () => Promise<void>;
     addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
 }, never>, Pick<{
@@ -32,7 +32,7 @@ export declare const useUserStore: import("pinia").StoreDefinition<"cosey-user",
     login: (data: any) => Promise<void>;
     getUserInfo: () => Promise<UserInfo | undefined>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void | undefined>;
+    setAuthorization: () => Promise<void>;
     addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
 }, "changePassword" | "login" | "logout" | "getUserInfo" | "setAuthorization" | "addDynamicRoutes">>;

package/store/user.js

@@ -20,6 +20,7 @@ const useUserStore = defineStore("cosey-user", () => {
     defineAuthority
   } = useGlobalConfig() || {};
   const filterRouteHandler = isFunction(filterRoute) ? filterRoute : filterRoute.hook();
+  const defineAuthorityHandler = isFunction(defineAuthority) ? defineAuthority : defineAuthority.hook();
   if (!apiConfig?.login) {
     warningOnce(!!apiConfig?.login, 'The "login" api is required.');
   }
@@ -57,7 +58,7 @@ const useUserStore = defineStore("cosey-user", () => {
     });
   };
   const setAuthorization = async () => {
-    return defineAuthority?.(userInfo.value);
+    return defineAuthorityHandler(userInfo.value);
   };
   const mapRoute = (routes) => {
     return routes.map((route2) => {