@kengic/vue 0.6.3-beta.4 → 0.6.4-beta.0

package/dist/src/components/KgSubmit/index.hooks.d.ts

@@ -2,7 +2,7 @@ import { RuleObject } from 'ant-design-vue/es/form';
 import { FormInstance } from 'ant-design-vue/lib/form/Form';
 import { Ref } from 'vue';
 import { IRemoveEventListenerHandler, KG_VAR_SUBMIT__DISPLAY_TYPE } from '../../consts';
-import { IKgSubmitAfterValidateCb, IKgSubmitBeforeOkCb, IKgSubmitBeforeRequestCb, IKgSubmitCloseCb, IKgSubmitOkCb, IKgSubmitOpenCb, IKgSubmitStore } from './index.store';
+import { IKgSubmitAfterValidateCb, IKgSubmitBeforeOkCb, IKgSubmitBeforeRequestCb, IKgSubmitCloseCb, IKgSubmitErrorCb, IKgSubmitOkCb, IKgSubmitOpenCb, IKgSubmitStore } from './index.store';
 export declare type IUseKgSubmit = {
     formID: string;
     /** 状态数据. */
@@ -13,7 +13,7 @@ export declare type IUseKgSubmit = {
     rules: Ref<Record<string, Array<RuleObject>>>;
     /** 显示方式. */
     displayType: Ref<KG_VAR_SUBMIT__DISPLAY_TYPE>;
-    /** 监听事件: 打开抽屉. */
+    /** 监听事件: 打开弹窗. */
     onOpen(cb: IKgSubmitOpenCb): IRemoveEventListenerHandler;
     /** 监听事件: 点击保存按钮之后, 执行默认逻辑之前. 可以在此时修改表单的值; 可以在此时对表单的值进行验证, 如果返回 true 表示表单验证失败, 不会再执行后面的代码. */
     onBeforeOk(cb: IKgSubmitBeforeOkCb): IRemoveEventListenerHandler;
@@ -21,9 +21,11 @@ export declare type IUseKgSubmit = {
     onAfterValidate(cb: IKgSubmitAfterValidateCb): IRemoveEventListenerHandler;
     /** 监听事件: 发起请求之前. */
     onBeforeRequest(cb: IKgSubmitBeforeRequestCb): IRemoveEventListenerHandler;
-    /** 监听事件: 点击保存按钮之后, 执行默认逻辑之后, 调用接口成功, 即将关闭抽屉. */
+    /** 监听事件: 点击保存按钮之后, 执行默认逻辑之后, 调用接口成功, 即将关闭弹窗. */
     onOk(cb: IKgSubmitOkCb): IRemoveEventListenerHandler;
-    /** 监听事件: 关闭抽屉. 点击取消或者点击确定并且成功之后, 都会触发 */
+    /** 监听事件: 请求失败. 请求失败了, 或者请求返回了错误消息. */
+    onError(cb: IKgSubmitErrorCb): IRemoveEventListenerHandler;
+    /** 监听事件: 关闭弹窗. 点击取消或者点击确定并且成功之后, 都会触发. */
     onClose(cb: IKgSubmitCloseCb): IRemoveEventListenerHandler;
 };
 /**

package/dist/src/components/KgSubmit/index.store.d.ts

@@ -5,14 +5,15 @@ import { Ref } from 'vue';
 import { IKgTableRow } from '../KgTable';
 /**
  * 事件类型.
- *   'open':          打开抽屉
- *   'close':         关闭抽屉
+ *   'open':          打开弹窗
  *   'beforeOk':      点击保存按钮之后, 执行默认逻辑之前
  *   'afterValidate': 表单验证成功
  *   'beforeRequest': 发起请求之前
- *   'ok':            请求成功, 即将关闭抽屉
+ *   'ok':            请求成功, 即将关闭弹窗
+ *   'error':         请求失败. 请求失败了, 或者请求返回了错误消息
+ *   'close':         关闭弹窗
  */
-export declare type IKgSubmitEvent = 'open' | 'close' | 'beforeOk' | 'afterValidate' | 'beforeRequest' | 'ok';
+export declare type IKgSubmitEvent = 'open' | 'close' | 'beforeOk' | 'afterValidate' | 'beforeRequest' | 'ok' | 'error';
 /** 事件监听函数: open. */
 export declare type IKgSubmitOpenCbParam = {
     isCreating: boolean;
@@ -62,7 +63,9 @@ export declare type IKgSubmitBeforeRequestCbParam = {
 export declare type IKgSubmitBeforeRequestCb = (param: IKgSubmitBeforeRequestCbParam) => Promise<boolean>;
 /** 事件监听函数: ok. */
 export declare type IKgSubmitOkCb = (param?: any | null) => Promise<boolean>;
-export declare type IKgSubmitCb = IKgSubmitOpenCb | IKgSubmitCloseCb | IKgSubmitBeforeOkCb | IKgSubmitAfterValidateCb | IKgSubmitBeforeRequestCb | IKgSubmitOkCb;
+/** 事件监听函数: error. */
+export declare type IKgSubmitErrorCb = (param: any) => Promise<boolean>;
+export declare type IKgSubmitCb = IKgSubmitOpenCb | IKgSubmitCloseCb | IKgSubmitBeforeOkCb | IKgSubmitAfterValidateCb | IKgSubmitBeforeRequestCb | IKgSubmitOkCb | IKgSubmitErrorCb;
 export interface IKgSubmitState {
     openListenersMap: Map<string, Array<IKgSubmitOpenCb>>;
     closeListenersMap: Map<string, Array<IKgSubmitCloseCb>>;
@@ -70,6 +73,7 @@ export interface IKgSubmitState {
     afterValidateListenersMap: Map<string, Array<IKgSubmitAfterValidateCb>>;
     beforeRequestListenersMap: Map<string, Array<IKgSubmitBeforeRequestCb>>;
     okListenersMap: Map<string, Array<IKgSubmitOkCb>>;
+    errorListenersMap: Map<string, Array<IKgSubmitErrorCb>>;
     isLoadingMap: Map<string, boolean>;
     /** 表单数据对象. */
     modelMap: Map<string, Record<string, any>>;
@@ -92,9 +96,9 @@ export declare type IKgSubmitStoreDefinition = StoreDefinition<'KgSubmit', IKgSu
      * 触发事件.
      * @param formID 界面标识.
      * @param event 事件名称.
-     * @param args 数据.
+     * @param param 数据.
      */
-    emit(formID: string, event: IKgSubmitEvent, args?: any | null): Promise<boolean>;
+    emit(formID: string, event: IKgSubmitEvent, param?: any | null): Promise<boolean>;
     setIsLoading(formID: string, value: boolean): void;
     setModel(formID: string, model: Record<string, any>): void;
 }>;

package/dist/src/components/KgTable/index.vm.d.ts

@@ -54,6 +54,7 @@ export interface IKgTableCellDisplayTypeProperties {
          */
         nilAsFalse?: boolean;
     };
+    /** @deprecated 请使用 {@link IKgTableCellDisplayTypeProperties.DESC}. */
     ENUM: Array<{
         /** 变量名称. */
         varName: string;
@@ -84,10 +85,28 @@ export interface IKgTableCellDisplayTypeProperties {
     };
     DESC: {
         /**
-         * 描述字段的名称.
+         * 对应的描述字段的名称.
          * @default 原字段 + '_dsc'
          */
         dscFieldName?: string;
+        /**
+         * 是否显示为一个 Tag 标签.
+         * @default false
+         */
+        isTag?: boolean;
+        /**
+         * 如果 {@link IKgTableCellDisplayTypeProperties.DESC.isTag} 为 true,
+         * 则该属性用来定义每个值对应的标签颜色是什么.
+         */
+        tagColors?: Array<{
+            /** 数据. */
+            value: any;
+            /**
+             * 颜色.
+             * @default 'default'
+             */
+            color?: string;
+        }>;
     };
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kengic/vue",
-    "version": "0.6.3-beta.4",
+    "version": "0.6.4-beta.0",
     "scripts": {
         "build": "rimraf dist && vue-tsc && vite build",
         "build:dev": "rimraf dist && vue-tsc && vite build --mode development",