@kengic/vue 0.22.0 → 0.23.0

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

@@ -1,272 +1,57 @@
+import { FormInstance } from 'ant-design-vue';
+import { ComputedRef, Ref } from 'vue';
 import { VarSubmitConfig, VarSubmitDetail } from '../../apis/WMS/models';
-import { IKgVarSubmitConfigProps, KG__VAR_SUBMIT_CONFIG__DISPLAY_TYPE, KG_BUTTON_TYPE } from '../../consts';
-import { IKgSubmitAfterValidateCb, IKgSubmitBeforeOkCb, IKgSubmitBeforeOpenCb, IKgSubmitBeforeRequestCb, IKgSubmitCloseCb, IKgSubmitErrorCb, IKgSubmitEvent, IKgSubmitOkCb, IKgSubmitOpenCb } from './index.store';
-/**
- * @param formID 界面标识.
- */
-export declare function useKgSubmit(formID?: string | null): {
-    /** 界面标识. */
-    formID: string;
-    /** 状态数据. */
-    store: import("pinia").Store<"KgSubmit", {
-        afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-        beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-        beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-        beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-        closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-        errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-        formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-        isLoadingMap: Map<string, boolean>;
-        modelMap: Map<string, Record<string, any>>;
-        okListenersMap: Map<string, IKgSubmitOkCb[]>; /**
-         * <p>「当前按钮」的「提交表单字段」的所属分组(可见的).</p>
-         */
-        openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-        rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-    }, {
-        isLoading(state: {
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>;
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>; /**
-             * <p>「当前按钮」的「提交表单字段」的所属分组(可见的).</p>
-             */
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        }>): (formID?: string | null | undefined) => boolean;
-        getModel(state: {
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>;
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>; /**
-             * <p>「当前按钮」的「提交表单字段」的所属分组(可见的).</p>
-             */
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        }>): (formID?: string | null | undefined) => Record<string, any> | null;
-        getFormRef(state: {
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>;
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>; /**
-             * <p>「当前按钮」的「提交表单字段」的所属分组(可见的).</p>
-             */
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        }>): (formID?: string | null | undefined) => import("vue").Ref<import("ant-design-vue").FormInstance | null>;
-        getRules(state: {
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>;
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>; /**
-             * <p>「当前按钮」的「提交表单字段」的所属分组(可见的).</p>
-             */
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        }>): (formID?: string | null | undefined) => import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>;
-        getVarSubmitConfig(state: {
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>;
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>; /**
-             * <p>「当前按钮」的「提交表单字段」的所属分组(可见的).</p>
-             */
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        }>): (formID: string | null | undefined, param?: {
-            buttonType?: KG_BUTTON_TYPE | undefined;
-            buttonVarName?: string | null | undefined;
-        } | undefined) => VarSubmitConfig | null;
-        getVarSubmitDetails(state: {
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>;
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        } & import("pinia").PiniaCustomStateProperties<{
-            afterValidateListenersMap: Map<string, IKgSubmitAfterValidateCb[]>;
-            beforeOkListenersMap: Map<string, IKgSubmitBeforeOkCb[]>;
-            beforeOpenListenersMap: Map<string, IKgSubmitBeforeOpenCb[]>;
-            beforeRequestListenersMap: Map<string, IKgSubmitBeforeRequestCb[]>;
-            closeListenersMap: Map<string, IKgSubmitCloseCb[]>;
-            errorListenersMap: Map<string, IKgSubmitErrorCb[]>;
-            formRefMap: Map<string, import("vue").Ref<import("ant-design-vue").FormInstance | null>>;
-            isLoadingMap: Map<string, boolean>;
-            modelMap: Map<string, Record<string, any>>;
-            okListenersMap: Map<string, IKgSubmitOkCb[]>; /**
-             * <p>「当前按钮」的「提交表单字段」的所属分组(可见的).</p>
-             */
-            openListenersMap: Map<string, IKgSubmitOpenCb[]>;
-            rulesMap: Map<string, import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>>;
-        }>): (formID: string | null | undefined, param?: {
-            buttonType?: KG_BUTTON_TYPE | undefined;
-            buttonVarName?: string | null | undefined;
-            isKey?: 0 | 1 | null | undefined;
-            isVisible?: 0 | 1 | null | undefined;
-            varName?: string | null | undefined;
-        } | null | undefined) => VarSubmitDetail[];
-    }, {
-        dispose(formID?: string | null | undefined): null | undefined;
-        addEventListener(formID: string, event: IKgSubmitEvent, cb: import("./index.store").IKgSubmitCb): void;
-        removeEventListener(formID: string, event: IKgSubmitEvent, cb?: import("./index.store").IKgSubmitCb | undefined): void;
-        emit(formID: string, event: IKgSubmitEvent, param: import("./index.store").IKgSubmitCbParam): Promise<boolean>;
-        setIsLoading(formID: string, value: boolean): void;
-        setModel(formID?: string | null | undefined, model?: Record<string, any> | null | undefined): void;
-        patchVarSubmitDetail(formID: string | null | undefined, param: {
-            buttonType?: KG_BUTTON_TYPE | undefined;
-            buttonVarName?: string | null | undefined;
-            properties: VarSubmitDetail;
-            varName: string | null | undefined;
-        }): void;
-    }>;
-    /** 表单数据对象. */
-    model: import("vue").ComputedRef<Record<string, any>>;
-    /** 表单组件. */
-    formRef: import("vue").Ref<import("ant-design-vue").FormInstance | null>;
-    /** 表单验证规则. */
-    rules: import("vue").Ref<Record<string, import("ant-design-vue/es/form").RuleObject[]>>;
+import { IKgVarSubmitConfigProperties, IRemoveEventListenerHandler, KG__VAR_SUBMIT_CONFIG__DISPLAY_TYPE, KG_BUTTON_TYPE } from '../../consts';
+import { IKgSubmitAfterValidateCb, IKgSubmitBeforeOkCb, IKgSubmitBeforeOpenCb, IKgSubmitBeforeRequestCb, IKgSubmitCloseCb, IKgSubmitErrorCb, IKgSubmitOkCb, IKgSubmitOpenCb, IKgSubmitStore } from './index.store';
+export interface IUseKgSubmit {
     /**
      * <p>「当前按钮」的「提交表单配置」.</p>
      */
-    currentVarSubmitConfig: import("vue").ComputedRef<VarSubmitConfig | null>;
+    currentVarSubmitConfig: ComputedRef<VarSubmitConfig | null>;
     /**
      * <p>「当前按钮」的「提交表单配置」的显示方式.</p>
      */
-    currentVarSubmitConfigDisplayType: import("vue").ComputedRef<KG__VAR_SUBMIT_CONFIG__DISPLAY_TYPE>;
+    currentVarSubmitConfigDisplayType: ComputedRef<KG__VAR_SUBMIT_CONFIG__DISPLAY_TYPE>;
     /**
      * <p>「当前按钮」的「提交表单配置」的配置属性.</p>
      */
-    currentVarSubmitConfigProps: import("vue").ComputedRef<IKgVarSubmitConfigProps>;
+    currentVarSubmitConfigProps: ComputedRef<IKgVarSubmitConfigProperties>;
     /**
-     * <p>「当前按钮」的「提交表单字段」.</p>
+     * <p>「当前按钮」的「提交表单字段」的所属分组(可见的).</p>
      */
-    currentVarSubmitDetails: import("vue").ComputedRef<VarSubmitDetail[]>;
+    currentVarSubmitDetailSectionsForVisible: ComputedRef<string[]>;
     /**
-     * <p>「当前按钮」的「提交表单字段」(可见的).</p>
+     * <p>「当前按钮」的「提交表单字段」.</p>
      */
-    currentVarSubmitDetailsForVisible: import("vue").ComputedRef<VarSubmitDetail[]>;
+    currentVarSubmitDetails: ComputedRef<VarSubmitDetail[]>;
     /**
      * <p>「当前按钮」的「提交表单字段」(关键的).</p>
      */
-    currentVarSubmitDetailsForKey: import("vue").ComputedRef<VarSubmitDetail[]>;
+    currentVarSubmitDetailsForKey: ComputedRef<VarSubmitDetail[]>;
     /**
      * <p>「当前按钮」的「提交表单字段」(关键的, 可见的).</p>
      */
-    currentVarSubmitDetailsForKeyAndVisible: import("vue").ComputedRef<VarSubmitDetail[]>;
+    currentVarSubmitDetailsForKeyAndVisible: ComputedRef<VarSubmitDetail[]>;
     /**
      * <p>「当前按钮」的「提交表单字段」(非关键的).</p>
      */
-    currentVarSubmitDetailsForNotKey: import("vue").ComputedRef<VarSubmitDetail[]>;
+    currentVarSubmitDetailsForNotKey: ComputedRef<VarSubmitDetail[]>;
     /**
      * <p>「当前按钮」的「提交表单字段」(非关键的, 可见的).</p>
      */
-    currentVarSubmitDetailsForNotKeyAndVisible: import("vue").ComputedRef<VarSubmitDetail[]>;
+    currentVarSubmitDetailsForNotKeyAndVisible: ComputedRef<VarSubmitDetail[]>;
     /**
-     * <p>「当前按钮」的「提交表单字段」的所属分组(可见的).</p>
+     * <p>「当前按钮」的「提交表单字段」(可见的).</p>
      */
-    currentVarSubmitDetailSectionsForVisible: import("vue").ComputedRef<string[]>;
+    currentVarSubmitDetailsForVisible: ComputedRef<VarSubmitDetail[]>;
+    /**
+     * 界面标识.
+     */
+    formID: string;
+    /**
+     * 表单组件.
+     */
+    formRef: Ref<FormInstance | null>;
     /**
      * <p>获取「提交表单配置」, 根据所传参数进行过滤.</p>
      *
@@ -322,33 +107,18 @@ export declare function useKgSubmit(formID?: string | null): {
         varName?: string | null;
     } | null): Array<VarSubmitDetail>;
     /**
-     * 修改某个「提交表单字段」的部分属性.
-     *
-     * @param param.buttonType <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
-     * @param param.buttonVarName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
-     * @param param.properties 要修改的部分属性.
-     * @param param.varName 「提交表单字段」的变量名称, 对应的是 {@link VarSubmitDetail.var_nam} 属性.
+     * 表单数据对象.
      */
-    patchVarSubmitDetail(param: {
-        buttonType?: KG_BUTTON_TYPE;
-        buttonVarName?: string | null;
-        properties: VarSubmitDetail;
-        varName: string | null | undefined;
-    }): void;
-    /**
-     * <p>事件: 打开提交弹窗之前.</p>
-     * @param cb 回调函数.
-     * @param once 是否只会触发一次. 默认为 undefined.
-     * @return {} 移除事件监听函数.
-     */
-    onBeforeOpen: (cb: IKgSubmitBeforeOpenCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
+    model: ComputedRef<Record<string, any>>;
     /**
-     * <p>事件: 打开提交弹窗.</p>
+     * <p>事件: 点击确认按钮之后, 表单验证完成.</p>
+     * <p>回调函数如果返回 true, 则不会再执行后面的代码.</p>
+     *
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      * @return {} 移除事件监听函数.
      */
-    onOpen: (cb: IKgSubmitOpenCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
+    onAfterValidate(cb: IKgSubmitAfterValidateCb, once?: boolean): IRemoveEventListenerHandler;
     /**
      * <p>事件: 点击确认按钮之后, 执行默认逻辑之前.</p>
      * <ul>
@@ -361,16 +131,14 @@ export declare function useKgSubmit(formID?: string | null): {
      * @param once 是否只会触发一次. 默认为 undefined.
      * @return {} 移除事件监听函数.
      */
-    onBeforeOk: (cb: IKgSubmitBeforeOkCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
+    onBeforeOk(cb: IKgSubmitBeforeOkCb, once?: boolean): IRemoveEventListenerHandler;
     /**
-     * <p>事件: 点击确认按钮之后, 表单验证完成.</p>
-     * <p>回调函数如果返回 true, 则不会再执行后面的代码.</p>
-     *
+     * <p>事件: 打开提交弹窗之前.</p>
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      * @return {} 移除事件监听函数.
      */
-    onAfterValidate: (cb: IKgSubmitAfterValidateCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
+    onBeforeOpen(cb: IKgSubmitBeforeOpenCb, once?: boolean): IRemoveEventListenerHandler;
     /**
      * <p>事件: 发起接口请求之前. 表单验证完成, 参数解析完成.</p>
      * <p>回调函数如果返回 true, 则不会再执行后面的代码.</p>
@@ -379,31 +147,64 @@ export declare function useKgSubmit(formID?: string | null): {
      * @param once 是否只会触发一次. 默认为 undefined.
      * @return {} 移除事件监听函数.
      */
-    onBeforeRequest: (cb: IKgSubmitBeforeRequestCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
+    onBeforeRequest(cb: IKgSubmitBeforeRequestCb, once?: boolean): IRemoveEventListenerHandler;
     /**
-     * <p>事件: 点击保存按钮之后, 执行默认逻辑之后, 调用接口成功, 即将关闭提交弹窗.</p>
+     * <p>事件: 关闭提交弹窗. 下面几种场景都会触发此事件:</p>
+     * <ul>
+     *     <li>点击右上角的关闭按钮,</li>
+     *     <li>点击取消按钮,</li>
+     *     <li>点击保存按钮之后, 调用接口成功, 关闭弹窗,</li>
+     * </ul>
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      * @return {} 移除事件监听函数.
      */
-    onOk: (cb: IKgSubmitOkCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
+    onClose(cb: IKgSubmitCloseCb, once?: boolean): IRemoveEventListenerHandler;
     /**
      * <p>事件: 请求失败. 请求失败了, 或者请求返回了错误消息.</p>
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      * @return {} 移除事件监听函数.
      */
-    onError: (cb: IKgSubmitErrorCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
+    onError(cb: IKgSubmitErrorCb, once?: boolean): IRemoveEventListenerHandler;
     /**
-     * <p>事件: 关闭提交弹窗. 下面几种场景都会触发此事件:</p>
-     * <ul>
-     *     <li>点击右上角的关闭按钮,</li>
-     *     <li>点击取消按钮,</li>
-     *     <li>点击保存按钮之后, 调用接口成功, 关闭弹窗,</li>
-     * </ul>
+     * <p>事件: 点击保存按钮之后, 执行默认逻辑之后, 调用接口成功, 即将关闭提交弹窗.</p>
+     * @param cb 回调函数.
+     * @param once 是否只会触发一次. 默认为 undefined.
+     * @return {} 移除事件监听函数.
+     */
+    onOk(cb: IKgSubmitOkCb, once?: boolean): IRemoveEventListenerHandler;
+    /**
+     * <p>事件: 打开提交弹窗.</p>
      * @param cb 回调函数.
      * @param once 是否只会触发一次. 默认为 undefined.
      * @return {} 移除事件监听函数.
      */
-    onClose: (cb: IKgSubmitCloseCb, once?: boolean | undefined) => import("../../consts").IRemoveEventListenerHandler;
-};
+    onOpen(cb: IKgSubmitOpenCb, once?: boolean): IRemoveEventListenerHandler;
+    /**
+     * 修改某个「提交表单字段」的部分属性.
+     *
+     * @param param.buttonType <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
+     * @param param.buttonVarName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
+     * @param param.properties 要修改的部分属性.
+     * @param param.varName 「提交表单字段」的变量名称, 对应的是 {@link VarSubmitDetail.var_nam} 属性.
+     */
+    patchVarSubmitDetail(param: {
+        buttonType?: KG_BUTTON_TYPE;
+        buttonVarName?: string | null;
+        properties: VarSubmitDetail;
+        varName: string | null | undefined;
+    }): void;
+    /**
+     * 表单验证规则.
+     */
+    rules: ReturnType<IKgSubmitStore['getRules']>;
+    /**
+     * 状态数据.
+     */
+    store: IKgSubmitStore;
+}
+/**
+ * @param formID 界面标识.
+ */
+export declare function useKgSubmit(formID?: string | null): IUseKgSubmit;