@kengic/vue 0.6.4 → 0.6.5

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

@@ -1,6 +1,6 @@
 import { ComputedRef, Ref } from 'vue';
 import { IRemoveEventListenerHandler } from '../../consts';
-import { IKgTableRetrieveCb, IKgTableRowDoubleClickCb, IKgTableStore } from './index.store';
+import { IKgTableBeforeRetrieveCb, IKgTableRetrieveCb, IKgTableRowDoubleClickCb, IKgTableStore } from './index.store';
 export declare type IUseKgTable = {
     formID: string;
     /** 状态数据. */
@@ -31,6 +31,8 @@ export declare type IUseKgTable = {
     profileFormID: Ref<string>;
     /** 监听事件: 双击某行. */
     onRowDoubleClick(cb: IKgTableRowDoubleClickCb): IRemoveEventListenerHandler;
+    /** 监听事件: 即将发起查询请求. */
+    onBeforeRetrieve(cb: IKgTableBeforeRetrieveCb): IRemoveEventListenerHandler;
     /** 监听事件: 查询数据成功. */
     onRetrieve(cb: IKgTableRetrieveCb): IRemoveEventListenerHandler;
 };

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

@@ -5,20 +5,29 @@ import { IKgTableRow } from './index.vm';
 /**
  * 事件类型.
  *   'rowDoubleClick': 双击某行
+ *   'beforeRetrieve': 即将发起查询请求
  *   'retrieve':       查询数据成功
  */
-export declare type IKgTableEvent = 'rowDoubleClick' | 'retrieve';
+export declare type IKgTableEvent = 'rowDoubleClick' | 'beforeRetrieve' | 'retrieve';
 /** 事件监听函数: rowDoubleClick. */
-export declare type IKgTableRowDoubleClickCb = (record: IKgTableRow) => void;
-/**
- * 事件监听函数: retrieve.
- * @param page 分页数据.
- */
-export declare type IKgTableRetrieveCb = (args: {
+export declare type IKgTableRowDoubleClickCb = (record: IKgTableRow) => Promise<boolean>;
+/** 事件监听函数: retrieve. */
+export declare type IKgTableRetrieveCbParam = {
+    /** 接口返回的分页数据. */
     page: IPage<IKgTableRow> | undefined | null;
+    /** 经过处理之后的列表数据. */
     datas: Ref<Array<IKgTableRow>>;
-}) => void;
-export declare type IKgTableCb = IKgTableRowDoubleClickCb | IKgTableRetrieveCb;
+};
+export declare type IKgTableRetrieveCb = (param: IKgTableRetrieveCbParam) => Promise<boolean>;
+/** 事件监听函数: beforeRetrieve. */
+export declare type IKgTableBeforeRetrieveCbParam = {
+    /** 查询接口请求参数. */
+    params: IPage<IKgTableRow> | undefined | null;
+    /** 查询接口返回的数据, 调用者可以直接修改该数据, 从而实现手动提供表格数据. */
+    response: Ref;
+};
+export declare type IKgTableBeforeRetrieveCb = (param: IKgTableBeforeRetrieveCbParam) => Promise<boolean>;
+export declare type IKgTableCb = IKgTableRowDoubleClickCb | IKgTableBeforeRetrieveCb | IKgTableRetrieveCb;
 export interface IKgTableState {
     /** 勾选的行. */
     selectedRowsMap: Map<string, Array<IKgTableRow>>;
@@ -34,6 +43,7 @@ export interface IKgTableState {
     tableWidthMap: Map<string, number>;
     /** '双击某行'事件监听函数列表. */
     rowDoubleClickListenersMap: Map<string, Array<IKgTableRowDoubleClickCb>>;
+    beforeRetrieveListenersMap: Map<string, Array<IKgTableBeforeRetrieveCb>>;
     retrieveListenersMap: Map<string, Array<IKgTableRetrieveCb>>;
 }
 export declare type IKgTableStoreDefinition = StoreDefinition<'KgTable', IKgTableState, {
@@ -50,7 +60,7 @@ export declare type IKgTableStoreDefinition = StoreDefinition<'KgTable', IKgTabl
     dispose(formID?: string | null): void;
     addEventListener(formID: string, event: IKgTableEvent, cb: IKgTableCb): void;
     removeEventListener(formID: string, event: IKgTableEvent, cb?: IKgTableCb): void;
-    emit(formID: string, event: IKgTableEvent, args?: any | null): void;
+    emit(formID: string, event: IKgTableEvent, param?: any | null): Promise<boolean>;
     setSelectedRows(formID: string, selectedRows: Array<IKgTableRow>): void;
     /**
      * 设置某行的勾选状态.

package/package.json

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