@kengic/vue 0.23.3 → 0.23.5

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

@@ -27,15 +27,15 @@ export declare type IUseKgAppSelect = {
     init(): void;
     /**
      * 监听事件: 进入某个模块.
-     * @param cb 事件监听函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
+     * @param listener 事件监听函数.
+     * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onGotoApp(cb: IKgAppSelectGotoAppEventListener, once?: boolean): IRemoveEventListenerHandler;
+    onGotoApp(listener: IKgAppSelectGotoAppEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
     /**
      * 监听事件: 进入某个地址.
-     * @param cb 事件监听函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
+     * @param listener 事件监听函数.
+     * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onGotoPath(cb: IKgAppSelectGotoPathEventListener, once?: boolean): IRemoveEventListenerHandler;
+    onGotoPath(listener: IKgAppSelectGotoPathEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
 };
 export declare function useKgAppSelect(): IUseKgAppSelect;

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

@@ -31,9 +31,9 @@ export interface IUseKgAppSelectStoreActions {
     /**
      * 注册事件监听.
      * @param event 事件名称.
-     * @param cb 事件监听函数.
+     * @param listener 事件监听函数.
      */
-    addEventListener(event: IKgAppSelectEvent, cb: IKgAppSelectEventListener): void;
+    addEventListener(event: IKgAppSelectEvent, listener: IKgAppSelectEventListener): void;
     /**
      * 触发事件.
      * @param event 事件名称.
@@ -65,9 +65,9 @@ export interface IUseKgAppSelectStoreActions {
     /**
      * 退订事件监听.
      * @param event 事件名称.
-     * @param cb 事件监听函数.
+     * @param listener 事件监听函数.
      */
-    removeEventListener(event: IKgAppSelectEvent, cb?: IKgAppSelectEventListener): void;
+    removeEventListener(event: IKgAppSelectEvent, listener?: IKgAppSelectEventListener): void;
 }
 export declare type IUseKgAppSelectStore = StoreDefinition<'KgAppSelect', IUseKgAppSelectStoreState, IUseKgAppSelectStoreGetters, IUseKgAppSelectStoreActions>;
 export declare type IKgAppSelectStore = ReturnType<IUseKgAppSelectStore>;

package/dist/src/components/KgButton/KgButton.Item.d.ts

@@ -1,4 +1,4 @@
-import { KG__VAR_BUTTON__COLOR, KG_BUTTON_TYPE } from '../../consts';
+import { KG__VAR_BUTTON__COLOR, KG__VAR_BUTTON__TYPE } from '../../consts';
 import './KgButton.Item.less';
 declare const _default: import("vue").DefineComponent<{
     kgButton: import("vue").PropType<import("../..").VarButton>;
@@ -14,7 +14,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -31,7 +31,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

package/dist/src/components/KgButton/KgButton.Item.data.d.ts

@@ -1,6 +1,6 @@
 import { ExtractPropTypes, PropType } from 'vue';
 import { VarButton } from '../../apis/WMS/models';
-import { KG__VAR_BUTTON__COLOR, KG_BUTTON_TYPE } from '../../consts';
+import { KG__VAR_BUTTON__COLOR, KG__VAR_BUTTON__TYPE } from '../../consts';
 export declare const getProps: () => {
     /** 按钮. */
     kgButton: PropType<VarButton>;
@@ -23,7 +23,7 @@ export declare const getProps: () => {
     /** 文本. */
     kgText: PropType<string | null>;
     /** 按钮类型. */
-    kgType: PropType<KG_BUTTON_TYPE | null>;
+    kgType: PropType<KG__VAR_BUTTON__TYPE | null>;
     /** 变量名称. */
     kgVarName: PropType<string | null>;
     onKgClick: PropType<(args?: any) => Promise<boolean>>;

package/dist/src/components/KgButton/components/KgButton.Copy.d.ts

@@ -1,4 +1,4 @@
-import { KG_BUTTON_TYPE } from '../../../consts';
+import { KG__VAR_BUTTON__TYPE } from '../../../consts';
 declare const _default: import("vue").DefineComponent<{
     kgButton: import("vue").PropType<import("../../..").VarButton>;
     kgColor: import("vue").PropType<import("../../../consts").KG__VAR_BUTTON__COLOR | null>;
@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

package/dist/src/components/KgButton/components/KgButton.Create.d.ts

@@ -1,4 +1,4 @@
-import { KG__VAR_BUTTON__COLOR, KG_BUTTON_TYPE } from '../../../consts';
+import { KG__VAR_BUTTON__COLOR, KG__VAR_BUTTON__TYPE } from '../../../consts';
 declare const _default: import("vue").DefineComponent<{
     kgButton: import("vue").PropType<import("../../..").VarButton>;
     kgColor: import("vue").PropType<KG__VAR_BUTTON__COLOR | null>;
@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

package/dist/src/components/KgButton/components/KgButton.Delete.d.ts

@@ -1,4 +1,4 @@
-import { KG__VAR_BUTTON__COLOR, KG_BUTTON_TYPE } from '../../../consts';
+import { KG__VAR_BUTTON__COLOR, KG__VAR_BUTTON__TYPE } from '../../../consts';
 declare const _default: import("vue").DefineComponent<{
     kgButton: import("vue").PropType<import("../../..").VarButton>;
     kgColor: import("vue").PropType<KG__VAR_BUTTON__COLOR | null>;
@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

package/dist/src/components/KgButton/components/KgButton.Export.d.ts

@@ -1,4 +1,4 @@
-import { KG_BUTTON_TYPE } from '../../../consts';
+import { KG__VAR_BUTTON__TYPE } from '../../../consts';
 declare const _default: import("vue").DefineComponent<{
     kgButton: import("vue").PropType<import("../../..").VarButton>;
     kgColor: import("vue").PropType<import("../../../consts").KG__VAR_BUTTON__COLOR | null>;
@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

package/dist/src/components/KgButton/components/KgButton.Import.d.ts

@@ -1,4 +1,4 @@
-import { KG_BUTTON_TYPE } from '../../../consts';
+import { KG__VAR_BUTTON__TYPE } from '../../../consts';
 declare const _default: import("vue").DefineComponent<{
     kgButton: import("vue").PropType<import("../../..").VarButton>;
     kgColor: import("vue").PropType<import("../../../consts").KG__VAR_BUTTON__COLOR | null>;
@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

package/dist/src/components/KgButton/components/KgButton.ImportTemplate.d.ts

@@ -1,4 +1,4 @@
-import { KG_BUTTON_TYPE } from '../../../consts';
+import { KG__VAR_BUTTON__TYPE } from '../../../consts';
 declare const _default: import("vue").DefineComponent<{
     kgButton: import("vue").PropType<import("../../..").VarButton>;
     kgColor: import("vue").PropType<import("../../../consts").KG__VAR_BUTTON__COLOR | null>;
@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

package/dist/src/components/KgButton/components/KgButton.Other.d.ts

@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<import("../../../consts").KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<import("../../../consts").KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<import("../../../consts").KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<import("../../../consts").KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

package/dist/src/components/KgButton/components/KgButton.Search.d.ts

@@ -1,4 +1,4 @@
-import { KG__VAR_BUTTON__COLOR, KG_BUTTON_TYPE } from '../../../consts';
+import { KG__VAR_BUTTON__COLOR, KG__VAR_BUTTON__TYPE } from '../../../consts';
 declare const _default: import("vue").DefineComponent<{
     kgButton: import("vue").PropType<import("../../..").VarButton>;
     kgColor: import("vue").PropType<KG__VAR_BUTTON__COLOR | null>;
@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

package/dist/src/components/KgButton/components/KgButton.Update.d.ts

@@ -1,4 +1,4 @@
-import { KG_BUTTON_TYPE } from '../../../consts';
+import { KG__VAR_BUTTON__TYPE } from '../../../consts';
 declare const _default: import("vue").DefineComponent<{
     kgButton: import("vue").PropType<import("../../..").VarButton>;
     kgColor: import("vue").PropType<import("../../../consts").KG__VAR_BUTTON__COLOR | null>;
@@ -13,7 +13,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         default: undefined;
     };
     kgText: import("vue").PropType<string | null>;
-    kgType: import("vue").PropType<KG_BUTTON_TYPE | null>;
+    kgType: import("vue").PropType<KG__VAR_BUTTON__TYPE | null>;
     kgVarName: import("vue").PropType<string | null>;
     onKgClick: import("vue").PropType<(args?: any) => Promise<boolean>>;
 }>>, {

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

@@ -1,5 +1,5 @@
 import { ComputedRef } from 'vue';
-import { IRemoveEventListenerHandler, KG_BUTTON_TYPE } from '../../consts';
+import { IRemoveEventListenerHandler, KG__VAR_BUTTON__TYPE } from '../../consts';
 import { IKgButtonClickEventListener, IKgButtonImportOkEventListener, IKgButtonStore, IKgButtonSubmitCancelEventListener, IKgButtonSubmitSaveEventListener } from './index.store';
 export interface IUseKgButton {
     /**
@@ -10,7 +10,7 @@ export interface IUseKgButton {
      * @param param.variableName 按钮变量名称.
      */
     click(param: {
-        type: KG_BUTTON_TYPE;
+        type: KG__VAR_BUTTON__TYPE;
         variableName?: string;
     }): void;
     /**
@@ -23,26 +23,26 @@ export interface IUseKgButton {
     formID: string;
     /**
      * <p>判断某个按钮的 click 事件是否被拦截.</p>
-     * <p>用户调用 <code>kgVar.kgButton.onClick(cb)</code> 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
+     * <p>用户调用 <code>kgVar.kgButton.onClick(listener)</code> 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
      * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
      *
      * <ul>
      *     <li>
-     *         <p>如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG_BUTTON_TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
-     *         <p>调用方式如下: <code>isClickIntercepted({ type: KG_BUTTON_TYPE.CREATE });</code></p>
+     *         <p>如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG__VAR_BUTTON__TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
+     *         <p>调用方式如下: <code>isClickIntercepted({ type: KG__VAR_BUTTON__TYPE.CREATE });</code></p>
      *     </li>
      *     <li>
-     *         <p>如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG_BUTTON_TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
+     *         <p>如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG__VAR_BUTTON__TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
      *         <p>根据参数 {@link param.varName} 获取按钮.</p>
      *         <p>调用方式如下: <code>isClickIntercepted({ varName: 'SOME-OTHER-BUTTON' });</code></p>
      *     </li>
      * </ul>
      *
-     * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
+     * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG__VAR_BUTTON__TYPE}.</p>
      * @param param.varName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
      */
     isClickIntercepted(param: {
-        type?: KG_BUTTON_TYPE;
+        type?: KG__VAR_BUTTON__TYPE;
         varName?: string | null;
     }): boolean;
     /**
@@ -50,21 +50,21 @@ export interface IUseKgButton {
      *
      * <ul>
      *     <li>
-     *         <p>如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG_BUTTON_TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
-     *         <p>调用方式如下: <code>isCurrentButton({ type: KG_BUTTON_TYPE.CREATE });</code></p>
+     *         <p>如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG__VAR_BUTTON__TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
+     *         <p>调用方式如下: <code>isCurrentButton({ type: KG__VAR_BUTTON__TYPE.CREATE });</code></p>
      *     </li>
      *     <li>
-     *         <p>如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG_BUTTON_TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
+     *         <p>如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG__VAR_BUTTON__TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
      *         <p>根据参数 {@link param.varName} 获取按钮.</p>
      *         <p>调用方式如下: <code>isCurrentButton({ varName: 'SOME-OTHER-BUTTON' });</code></p>
      *     </li>
      * </ul>
      *
-     * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
+     * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG__VAR_BUTTON__TYPE}.</p>
      * @param param.varName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
      */
     isCurrentButton(param: {
-        type?: KG_BUTTON_TYPE;
+        type?: KG__VAR_BUTTON__TYPE;
         varName?: string;
     }): boolean;
     /**
@@ -78,31 +78,31 @@ export interface IUseKgButton {
     /**
      * 监听事件: 点击按钮.
      *
-     * @param cb 事件监听函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
+     * @param listener 事件监听函数.
+     * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onClick(cb: IKgButtonClickEventListener, once?: boolean): IRemoveEventListenerHandler;
+    onClick(listener: IKgButtonClickEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
     /**
      * 监听事件: 导入成功, 导入接口调用成功.
      *
-     * @param cb 事件监听函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
+     * @param listener 事件监听函数.
+     * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onImportOk(cb: IKgButtonImportOkEventListener, once?: boolean): IRemoveEventListenerHandler;
+    onImportOk(listener: IKgButtonImportOkEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
     /**
      * 监听事件: 表格内编辑时, 点击取消按钮.
      *
-     * @param cb 事件监听函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
+     * @param listener 事件监听函数.
+     * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onSubmitCancel(cb: IKgButtonSubmitCancelEventListener, once?: boolean): IRemoveEventListenerHandler;
+    onSubmitCancel(listener: IKgButtonSubmitCancelEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
     /**
      * 监听事件: 表格内编辑时, 点击保存按钮.
      *
-     * @param cb 事件监听函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
+     * @param listener 事件监听函数.
+     * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onSubmitSave(cb: IKgButtonSubmitSaveEventListener, once?: boolean): IRemoveEventListenerHandler;
+    onSubmitSave(listener: IKgButtonSubmitSaveEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
     /**
      * <p>「查询按钮」.</p>
      */
@@ -116,21 +116,21 @@ export interface IUseKgButton {
      *         <p>调用方式如下: <code>setCurrentButton(null);</code></p>
      *     </li>
      *     <li>
-     *         <p>否则, 如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG_BUTTON_TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
-     *         <p>调用方式如下: <code>setCurrentButton({ type: KG_BUTTON_TYPE.CREATE });</code></p>
+     *         <p>否则, 如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG__VAR_BUTTON__TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
+     *         <p>调用方式如下: <code>setCurrentButton({ type: KG__VAR_BUTTON__TYPE.CREATE });</code></p>
      *     </li>
      *     <li>
-     *         <p>否则, 如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG_BUTTON_TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
+     *         <p>否则, 如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG__VAR_BUTTON__TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
      *         <p>根据参数 {@link param.varName} 获取按钮.</p>
      *         <p>调用方式如下: <code>setCurrentButton({ varName: 'SOME-OTHER-BUTTON' });</code></p>
      *     </li>
      * </ul>
      *
-     * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
+     * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG__VAR_BUTTON__TYPE}.</p>
      * @param param.varName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
      */
     setCurrentButton(param: {
-        type?: KG_BUTTON_TYPE;
+        type?: KG__VAR_BUTTON__TYPE;
         varName?: string | null;
     } | null): Promise<void>;
     /**
@@ -138,23 +138,23 @@ export interface IUseKgButton {
      *
      * <ul>
      *     <li>
-     *         <p>如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG_BUTTON_TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
-     *         <p>调用方式如下: <code>setIsClickIntercepted({ type: KG_BUTTON_TYPE.CREATE, isIntercepted: true });</code></p>
+     *         <p>如果参数 {@link param.type} !== <code>undefined</code> && {@link param.type} !== {@link KG__VAR_BUTTON__TYPE.OTHER}, 则根据参数 {@link param.type} 获取按钮.</p>
+     *         <p>调用方式如下: <code>setIsClickIntercepted({ type: KG__VAR_BUTTON__TYPE.CREATE, isIntercepted: true });</code></p>
      *     </li>
      *     <li>
-     *         <p>如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG_BUTTON_TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
+     *         <p>如果参数 {@link param.type} === <code>undefined</code> || {@link param.type} === {@link KG__VAR_BUTTON__TYPE.OTHER}, 则参数 {@link param.varName} 必须传值, 否则报错.</p>
      *         <p>根据参数 {@link param.varName} 获取按钮.</p>
      *         <p>调用方式如下: <code>setIsClickIntercepted({ varName: 'SOME-OTHER-BUTTON', isIntercepted: true });</code></p>
      *     </li>
      * </ul>
      *
      * @param param.isIntercepted 是否被拦截.
-     * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
+     * @param param.type <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG__VAR_BUTTON__TYPE}.</p>
      * @param param.varName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
      */
     setIsClickIntercepted(param: {
         isIntercepted: boolean;
-        type?: KG_BUTTON_TYPE;
+        type?: KG__VAR_BUTTON__TYPE;
         varName?: string | null;
     }): void;
     /**
@@ -169,6 +169,10 @@ export interface IUseKgButton {
      * 状态数据.
      */
     store: IKgButtonStore;
+    /**
+     * 按钮配置.
+     */
+    varButtonConfig: ComputedRef<ReturnType<IKgButtonStore['getVarButtonConfig']>>;
     /**
      * 所有按钮.
      */

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

@@ -1,6 +1,6 @@
 import { StoreDefinition } from 'pinia';
-import { VarButton } from '../../apis/WMS/models';
-import { IKgEventListener, KG_BUTTON_TYPE } from '../../consts';
+import { VarButton, VarButtonConfig } from '../../apis/WMS/models';
+import { IKgEventListener, KG__VAR_BUTTON__TYPE } from '../../consts';
 /**
  * 事件类型.
  *   'click':             点击按钮
@@ -36,7 +36,7 @@ export interface IUseKgButtonStoreState {
     importOkEventListenersMap: Map<string, Array<IKgButtonImportOkEventListener>>;
     /**
      * <p>按钮的 click 事件是否被拦截.</p>
-     * <p>用户调用 kgVar.kgButton.onClick(cb) 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
+     * <p>用户调用 kgVar.kgButton.onClick(listener) 监听了 click 事件, 并且回调函数返回了 true, 表示该 click 事件被用户拦截了.</p>
      * <p>被拦截之后, 该按钮的默认逻辑不会执行(例如打开提交弹窗, 加载各种数据等等), 后续由用户自行处理.</p>
      */
     isClickInterceptedMap: Map<string, boolean>;
@@ -51,14 +51,15 @@ export interface IUseKgButtonStoreState {
 export interface IUseKgButtonStoreGetters {
     getCurrentButton(): (formID: string | null | undefined) => VarButton | null;
     getSearchButton(): (formID: string | null | undefined) => VarButton | null;
+    getVarButtonConfig(): (formID: string | null | undefined) => VarButtonConfig | null;
     getVarButtons(): (formID: string | null | undefined) => Array<VarButton>;
     isClickIntercepted(): (formID: string | undefined | null, param: {
-        type?: KG_BUTTON_TYPE;
+        type?: KG__VAR_BUTTON__TYPE;
         varName?: string | null;
     }) => boolean;
     isCurrentButton(): (formID: string, param: {
         varName?: string;
-        type?: KG_BUTTON_TYPE;
+        type?: KG__VAR_BUTTON__TYPE;
     }) => boolean;
     isCurrentButtonRequesting(): (formID: string | undefined | null) => boolean;
 }
@@ -67,9 +68,9 @@ export interface IUseKgButtonStoreActions {
      * 注册事件监听.
      * @param formID 界面标识.
      * @param event 事件名称.
-     * @param cb 事件监听函数.
+     * @param listener 事件监听函数.
      */
-    addEventListener(formID: string, event: IKgButtonEvent, cb: IKgButtonEventListener): void;
+    addEventListener(formID: string, event: IKgButtonEvent, listener: IKgButtonEventListener): void;
     /**
      * <p>手动点击某个按钮.</p>
      * <p>调用此方法相当于手动触发某个按钮的点击事件.</p>
@@ -78,7 +79,7 @@ export interface IUseKgButtonStoreActions {
      * @param type 按钮类型.
      * @param variableName 按钮变量名称.
      */
-    click(formID: string, type: KG_BUTTON_TYPE, variableName?: string): void;
+    click(formID: string, type: KG__VAR_BUTTON__TYPE, variableName?: string): void;
     dispose(formID: string | null | undefined): void;
     /**
      * 触发事件.
@@ -91,16 +92,16 @@ export interface IUseKgButtonStoreActions {
      * 退订事件监听.
      * @param formID 界面标识.
      * @param event 事件名称.
-     * @param cb 事件监听函数.
+     * @param listener 事件监听函数.
      */
-    removeEventListener(formID: string, event: IKgButtonEvent, cb?: IKgButtonEventListener): void;
+    removeEventListener(formID: string, event: IKgButtonEvent, listener?: IKgButtonEventListener): void;
     setCurrentButton(formID: string, param: {
-        type?: KG_BUTTON_TYPE;
+        type?: KG__VAR_BUTTON__TYPE;
         varName?: string | null;
     } | null): Promise<void>;
     setIsClickIntercepted(formID: string | undefined | null, param: {
         isIntercepted: boolean;
-        type?: KG_BUTTON_TYPE;
+        type?: KG__VAR_BUTTON__TYPE;
         varName?: string | null;
     }): void;
     setIsCurrentButtonRequesting(formID: string | undefined | null, param: {