@kengic/vue 0.23.3-beta.2 → 0.23.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. package/dist/index.css +1 -1
  2. package/dist/kengic-vue.js +3816 -3423
  3. package/dist/search-outlined.8364f123.mjs +8 -0
  4. package/dist/src/components/KgAppSelect/index.hooks.d.ts +8 -8
  5. package/dist/src/components/KgAppSelect/index.store.d.ts +4 -4
  6. package/dist/src/components/KgButton/KgButton.Item.d.ts +3 -3
  7. package/dist/src/components/KgButton/KgButton.Item.data.d.ts +2 -2
  8. package/dist/src/components/KgButton/components/KgButton.Copy.d.ts +3 -3
  9. package/dist/src/components/KgButton/components/KgButton.Create.d.ts +5 -5
  10. package/dist/src/components/KgButton/components/KgButton.Delete.d.ts +3 -3
  11. package/dist/src/components/KgButton/components/KgButton.Export.d.ts +3 -3
  12. package/dist/src/components/KgButton/components/KgButton.Import.d.ts +3 -3
  13. package/dist/src/components/KgButton/components/{KgButton.ExportTemplate.d.ts → KgButton.ImportTemplate.d.ts} +3 -3
  14. package/dist/src/components/KgButton/components/KgButton.Other.d.ts +2 -2
  15. package/dist/src/components/KgButton/components/KgButton.Search.d.ts +3 -3
  16. package/dist/src/components/KgButton/components/KgButton.Update.d.ts +3 -3
  17. package/dist/src/components/KgButton/index.hooks.d.ts +46 -40
  18. package/dist/src/components/KgButton/index.store.d.ts +13 -12
  19. package/dist/src/components/KgForm/index.hooks.d.ts +28 -28
  20. package/dist/src/components/KgForm/index.store.d.ts +11 -5
  21. package/dist/src/components/KgForm.Item/KgForm.Item.service.d.ts +3 -3
  22. package/dist/src/components/KgForm.Item/components/KgForm.Item.RadioGroup.d.ts +2 -2
  23. package/dist/src/components/KgForm.Item/components/KgForm.Item.Select.d.ts +0 -4
  24. package/dist/src/components/KgSearch/index.hooks.d.ts +12 -12
  25. package/dist/src/components/KgSearch/index.store.d.ts +4 -4
  26. package/dist/src/components/KgSubmit/index.hooks.d.ts +39 -39
  27. package/dist/src/components/KgSubmit/index.store.d.ts +8 -8
  28. package/dist/src/components/KgTable/index.hooks.d.ts +34 -34
  29. package/dist/src/components/KgTable/index.store.d.ts +12 -6
  30. package/dist/src/components/KgVar/index.hooks.d.ts +7 -7
  31. package/dist/src/components/KgVar/index.store.d.ts +6 -7
  32. package/dist/src/components/KgVarConfig/components/button/KgVarConfig.Modal.Button.VarButton.d.ts +1 -1
  33. package/dist/src/components/KgVarConfig/components/button/KgVarConfig.Modal.Button.VarButtonConfig.d.ts +6 -12
  34. package/dist/src/components/KgWarehouse/index.hooks.d.ts +4 -4
  35. package/dist/src/components/KgWarehouse/index.store.d.ts +4 -4
  36. package/dist/src/components/util.d.ts +5 -5
  37. package/dist/src/consts/index.vm.d.ts +42 -14
  38. package/dist/src/utils/kg.util.d.ts +2 -2
  39. package/dist/upload-outlined.7ffb99b8.mjs +8 -0
  40. package/package.json +1 -1
@@ -3,54 +3,54 @@ import { IKgFormChangeEventListener, IKgFormLookupBeforeOkEventListener, IKgForm
3
3
  export declare type IUseKgForm = {
4
4
  formID: string;
5
5
  /**
6
- * 事件: 表单控件的值发生变更.
6
+ * 监听事件: 表单控件的值发生变更.
7
7
  *
8
- * @param cb 回调函数.
9
- * @param once 是否只会触发一次. 默认为 undefined.
8
+ * @param listener 事件监听函数.
9
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
10
10
  */
11
- onChange(cb: IKgFormChangeEventListener, once?: boolean): IRemoveEventListenerHandler;
11
+ onChange(listener: IKgFormChangeEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
12
12
  /**
13
- * 事件: 查找弹窗点击确定之前. 如果返回 true 则查找弹窗不会触发 kgOk 事件.
13
+ * 监听事件: 查找弹窗点击确定之前. 如果返回 true 则查找弹窗不会触发 kgOk 事件.
14
14
  *
15
- * @param cb 回调函数.
16
- * @param once 是否只会触发一次. 默认为 undefined.
15
+ * @param listener 事件监听函数.
16
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
17
17
  */
18
- onLookupBeforeOk(cb: IKgFormLookupBeforeOkEventListener, once?: boolean): IRemoveEventListenerHandler;
18
+ onLookupBeforeOk(listener: IKgFormLookupBeforeOkEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
19
19
  /**
20
- * 事件: 查找弹窗打开之前.
20
+ * 监听事件: 查找弹窗打开之前.
21
21
  *
22
- * @param cb 回调函数.
23
- * @param once 是否只会触发一次. 默认为 undefined.
22
+ * @param listener 事件监听函数.
23
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
24
24
  */
25
- onLookupBeforeOpen(cb: IKgFormLookupBeforeOpenEventListener, once?: boolean): IRemoveEventListenerHandler;
25
+ onLookupBeforeOpen(listener: IKgFormLookupBeforeOpenEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
26
26
  /**
27
- * 事件: 查找弹窗点击确定.
27
+ * 监听事件: 查找弹窗点击确定.
28
28
  *
29
- * @param cb 回调函数.
30
- * @param once 是否只会触发一次. 默认为 undefined.
29
+ * @param listener 事件监听函数.
30
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
31
31
  */
32
- onLookupOk(cb: IKgFormLookupOkEventListener, once?: boolean): IRemoveEventListenerHandler;
32
+ onLookupOk(listener: IKgFormLookupOkEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
33
33
  /**
34
- * 事件: 即将发起查询请求, 如果返回 true 表示不会发起请求.
34
+ * 监听事件: 即将发起查询请求, 如果返回 true 表示不会发起请求.
35
35
  *
36
- * @param cb 回调函数.
37
- * @param once 是否只会触发一次. 默认为 undefined.
36
+ * @param callback 事件监听函数.
37
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
38
38
  */
39
- onSelectBeforeRequest(cb: IKgFormSelectBeforeRequestEventListener, once?: boolean): IRemoveEventListenerHandler;
39
+ onSelectBeforeRequest(callback: IKgFormSelectBeforeRequestEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
40
40
  /**
41
- * 事件: 查询请求成功, 列表数据尚未赋值. 此处可以对查询接口返回的列表数据作处理.
41
+ * 监听事件: 查询请求成功, 列表数据尚未赋值. 此处可以对查询接口返回的列表数据作处理.
42
42
  *
43
- * @param cb 回调函数.
44
- * @param once 是否只会触发一次. 默认为 undefined.
43
+ * @param callback 事件监听函数.
44
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
45
45
  */
46
- onSelectBeforeSetDatas(cb: IKgFormSelectBeforeSetDatasEventListener, once?: boolean): IRemoveEventListenerHandler;
46
+ onSelectBeforeSetDatas(callback: IKgFormSelectBeforeSetDatasEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
47
47
  /**
48
- * 事件: 下拉列表选中某个(可能多个)数据.
48
+ * 监听事件: 下拉列表选中某个(可能多个)数据.
49
49
  *
50
- * @param cb 回调函数.
51
- * @param once 是否只会触发一次. 默认为 undefined.
50
+ * @param listener 事件监听函数.
51
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
52
52
  */
53
- onSelectChange(cb: IKgFormSelectChangeEventListener, once?: boolean): IRemoveEventListenerHandler;
53
+ onSelectChange(listener: IKgFormSelectChangeEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
54
54
  /**
55
55
  * 状态数据.
56
56
  */
@@ -18,9 +18,13 @@ export declare type IKgFormChangeEventListenerParameter = {
18
18
  * 表单控件所处环境.
19
19
  */
20
20
  context: KG_FORM_CONTEXT;
21
+ /** @deprecated */
21
22
  isCopying: boolean | null;
23
+ /** @deprecated */
22
24
  isCreating: boolean | null;
25
+ /** @deprecated */
23
26
  isDeleting: boolean | null;
27
+ /** @deprecated */
24
28
  isUpdating: boolean | null;
25
29
  /**
26
30
  * 表单控件当前数据.
@@ -73,8 +77,10 @@ export declare type IKgFormSelectChangeEventListenerParameter = {
73
77
  /** 是否多选, 否则单选. */
74
78
  isMultiple: boolean;
75
79
  isUpdating: boolean | null;
76
- /** 表单数据对象. */
80
+ /** @deprecated 已弃用, 请使用 {@link formModel}. */
77
81
  model: Ref<Record<string, any> | null> | null;
82
+ /** 表单数据对象. */
83
+ formModel: Ref<Record<string, any> | null> | null;
78
84
  /** 选中的数据对象组成的数组, 如果是单选则数组中只有一个数据对象. */
79
85
  rows: Array<any> | null;
80
86
  /** 选中的数据组成的数组, 如果是单选则数组中只有一个数据. */
@@ -164,9 +170,9 @@ export interface IUseKgFormStoreActions {
164
170
  * 注册事件监听.
165
171
  * @param formID 界面标识.
166
172
  * @param event 事件名称.
167
- * @param cb 回调函数.
173
+ * @param listener 事件监听函数.
168
174
  */
169
- addEventListener(formID: string, event: IKgFormEvent, cb: IKgFormEventListener): void;
175
+ addEventListener(formID: string, event: IKgFormEvent, listener: IKgFormEventListener): void;
170
176
  /**
171
177
  * 清理数据.
172
178
  * @param formID 页面标识.
@@ -183,9 +189,9 @@ export interface IUseKgFormStoreActions {
183
189
  * 退订事件监听.
184
190
  * @param formID 界面标识.
185
191
  * @param event 事件名称.
186
- * @param cb 回调函数.
192
+ * @param listener 事件监听函数.
187
193
  */
188
- removeEventListener(formID: string, event: IKgFormEvent, cb?: IKgFormEventListener): void;
194
+ removeEventListener(formID: string, event: IKgFormEvent, listener?: IKgFormEventListener): void;
189
195
  }
190
196
  export declare type IUseKgFormStore = StoreDefinition<'KgForm', IUseKgFormStoreState, IUseKgFormStoreGetters, IUseKgFormStoreActions>;
191
197
  export declare type IKgFormStore = ReturnType<IUseKgFormStore>;
@@ -1,9 +1,9 @@
1
+ import { RuleObject } from 'ant-design-vue/es/form';
1
2
  import { KgFormItemProps } from './index.vm';
2
3
  export declare function _useFormRules(props: KgFormItemProps): {
3
4
  /** 表单验证规则. */
4
- formRules: import("vue").ComputedRef<import("ant-design-vue/es/form").RuleObject[]>;
5
- /** 正在计算表单验证规则. */
6
- isFormRulesLoading: import("vue").Ref<boolean>;
5
+ formRules: import("vue").ComputedRef<RuleObject[]>;
6
+ isFormRulesChange: import("vue").Ref<boolean>;
7
7
  };
8
8
  export declare function useKgFormItem<T = Record<string, any>>(props?: KgFormItemProps): {
9
9
  /** 控件类型. */
@@ -16,7 +16,7 @@ declare const _default: import("vue").DefineComponent<{
16
16
  kgPlaceholder: import("vue").PropType<string>;
17
17
  kgMode: import("vue").PropType<"multiple" | "tags">;
18
18
  kgShowLabel: {
19
- type: import("vue").PropType<boolean>;
19
+ type: import("vue").PropType<boolean>; /** 初始. */
20
20
  default: boolean;
21
21
  };
22
22
  kgAllowClear: {
@@ -58,7 +58,7 @@ declare const _default: import("vue").DefineComponent<{
58
58
  kgPlaceholder: import("vue").PropType<string>;
59
59
  kgMode: import("vue").PropType<"multiple" | "tags">;
60
60
  kgShowLabel: {
61
- type: import("vue").PropType<boolean>;
61
+ type: import("vue").PropType<boolean>; /** 初始. */
62
62
  default: boolean;
63
63
  };
64
64
  kgAllowClear: {
@@ -20,7 +20,6 @@ declare const _default: import("vue").DefineComponent<{
20
20
  default: boolean;
21
21
  };
22
22
  kgAllowClear: {
23
- /** 是否允许清空. */
24
23
  type: import("vue").PropType<boolean>;
25
24
  default: undefined;
26
25
  };
@@ -37,7 +36,6 @@ declare const _default: import("vue").DefineComponent<{
37
36
  type: import("vue").PropType<import("../index.vm").IKgFormItemValue>;
38
37
  default: undefined;
39
38
  };
40
- /** 初始. */
41
39
  'onUpdate:value': import("vue").PropType<(value: import("../index.vm").IKgFormItemValue | null) => void>;
42
40
  onKgSubmit: import("vue").PropType<() => void>;
43
41
  onKgChange: import("vue").PropType<(value: any) => void>;
@@ -64,7 +62,6 @@ declare const _default: import("vue").DefineComponent<{
64
62
  default: boolean;
65
63
  };
66
64
  kgAllowClear: {
67
- /** 是否允许清空. */
68
65
  type: import("vue").PropType<boolean>;
69
66
  default: undefined;
70
67
  };
@@ -81,7 +78,6 @@ declare const _default: import("vue").DefineComponent<{
81
78
  type: import("vue").PropType<import("../index.vm").IKgFormItemValue>;
82
79
  default: undefined;
83
80
  };
84
- /** 初始. */
85
81
  'onUpdate:value': import("vue").PropType<(value: import("../index.vm").IKgFormItemValue | null) => void>;
86
82
  onKgSubmit: import("vue").PropType<() => void>;
87
83
  onKgChange: import("vue").PropType<(value: any) => void>;
@@ -34,23 +34,23 @@ export declare type IUseKgSearch = {
34
34
  */
35
35
  model: ComputedRef<ReturnType<IKgSearchStore['getFormModel']>>;
36
36
  /**
37
- * 事件: ready, 查询字段初始完成, 组件渲染完成.
38
- * @param cb 回调函数.
39
- * @param once 是否只会触发一次. 默认为 undefined.
37
+ * 监听事件: ready, 查询字段初始完成, 组件渲染完成.
38
+ * @param listener 事件监听函数.
39
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
40
40
  */
41
- onReady(cb: IKgSearchReadyEventListener, once?: boolean): IRemoveEventListenerHandler;
41
+ onReady(listener: IKgSearchReadyEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
42
42
  /**
43
- * 事件: reset, 点击重置按钮.
44
- * @param cb 回调函数.
45
- * @param once 是否只会触发一次. 默认为 undefined.
43
+ * 监听事件: reset, 点击重置按钮.
44
+ * @param listener 事件监听函数.
45
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
46
46
  */
47
- onReset(cb: IKgSearchResetEventListener, once?: boolean): IRemoveEventListenerHandler;
47
+ onReset(listener: IKgSearchResetEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
48
48
  /**
49
- * 事件: search, 点击查询按钮, 并且表单验证通过.
50
- * @param cb 回调函数.
51
- * @param once 是否只会触发一次. 默认为 undefined.
49
+ * 监听事件: search, 点击查询按钮, 并且表单验证通过.
50
+ * @param listener 事件监听函数.
51
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
52
52
  */
53
- onSearch(cb: IKgSearchSearchEventListener, once?: boolean): IRemoveEventListenerHandler;
53
+ onSearch(listener: IKgSearchSearchEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
54
54
  /** 重置. */
55
55
  reset(): void;
56
56
  /** 查询. */
@@ -80,9 +80,9 @@ export interface IUseKgSearchStoreActions {
80
80
  * 注册事件监听.
81
81
  * @param formID 界面标识.
82
82
  * @param event 事件名称.
83
- * @param cb 回调函数.
83
+ * @param listener 事件监听函数.
84
84
  */
85
- addEventListener(formID: string, event: IKgSearchEvent, cb: IKgSearchEventListener): void;
85
+ addEventListener(formID: string, event: IKgSearchEvent, listener: IKgSearchEventListener): void;
86
86
  /**
87
87
  * 清理数据.
88
88
  * @param formID 页面标识.
@@ -113,9 +113,9 @@ export interface IUseKgSearchStoreActions {
113
113
  * 退订事件监听.
114
114
  * @param formID 界面标识.
115
115
  * @param event 事件名称.
116
- * @param cb 回调函数.
116
+ * @param listener 事件监听函数.
117
117
  */
118
- removeEventListener(formID: string, event: IKgSearchEvent, cb?: IKgSearchEventListener): void;
118
+ removeEventListener(formID: string, event: IKgSearchEvent, listener?: IKgSearchEventListener): void;
119
119
  setDynamicQueryOperatorModel(formID: string | null | undefined, model?: Record<string, any> | null): void;
120
120
  /**
121
121
  * 设置表单数据.
@@ -1,7 +1,7 @@
1
1
  import { FormInstance } from 'ant-design-vue';
2
2
  import { ComputedRef, Ref } from 'vue';
3
3
  import { VarSubmitConfig, VarSubmitDetail } from '../../apis/WMS/models';
4
- import { IKgVarSubmitConfigProperties, IRemoveEventListenerHandler, KG__VAR_SUBMIT_CONFIG__DISPLAY_TYPE, KG__VAR_SUBMIT_CONFIG__LAYOUT, KG_BUTTON_TYPE, KG__VAR_SUBMIT_CONFIG_LABEL_COLUMN_UNIT } from '../../consts';
4
+ import { IKgVarSubmitConfigProperties, IRemoveEventListenerHandler, KG__VAR_BUTTON__TYPE, KG__VAR_SUBMIT_CONFIG__DISPLAY_TYPE, KG__VAR_SUBMIT_CONFIG__LAYOUT, KG__VAR_SUBMIT_CONFIG_LABEL_COLUMN_UNIT } from '../../consts';
5
5
  import { IKgSubmitAfterValidateEventListener, IKgSubmitBeforeOkEventListener, IKgSubmitBeforeOpenEventListener, IKgSubmitBeforeRequestEventListener, IKgSubmitCloseEventListener, IKgSubmitErrorEventListener, IKgSubmitOkEventListener, IKgSubmitOpenEventListener, IKgSubmitStore } from './index.store';
6
6
  export interface IUseKgSubmit {
7
7
  /**
@@ -79,11 +79,11 @@ export interface IUseKgSubmit {
79
79
  * </li>
80
80
  * </ul>
81
81
  *
82
- * @param param.buttonType <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
82
+ * @param param.buttonType <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG__VAR_BUTTON__TYPE}.</p>
83
83
  * @param param.buttonVarName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
84
84
  */
85
85
  getVarSubmitConfig(param?: {
86
- buttonType?: KG_BUTTON_TYPE;
86
+ buttonType?: KG__VAR_BUTTON__TYPE;
87
87
  buttonVarName?: string | null;
88
88
  }): VarSubmitConfig | null;
89
89
  /**
@@ -107,13 +107,13 @@ export interface IUseKgSubmit {
107
107
  * </li>
108
108
  * </ul>
109
109
  *
110
- * @param param.buttonType <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
110
+ * @param param.buttonType <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG__VAR_BUTTON__TYPE}.</p>
111
111
  * @param param.buttonVarName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
112
112
  * @param param.isVisible 提交表单字段是否可见, 对应的是 {@link VarSubmitDetail.visible_flag} 属性.
113
113
  * @param param.varName 提交表单字段的变量名, 对应的是 {@link VarSubmitDetail.var_nam} 属性.
114
114
  */
115
115
  getVarSubmitDetails(param?: {
116
- buttonType?: KG_BUTTON_TYPE;
116
+ buttonType?: KG__VAR_BUTTON__TYPE;
117
117
  buttonVarName?: string | null;
118
118
  isVisible?: 0 | 1 | null;
119
119
  varName?: string | null;
@@ -125,87 +125,87 @@ export interface IUseKgSubmit {
125
125
  */
126
126
  model: ComputedRef<Record<string, any>>;
127
127
  /**
128
- * <p>事件: 点击确认按钮之后, 表单验证完成.</p>
128
+ * <p>监听事件: 点击确认按钮之后, 表单验证完成.</p>
129
129
  * <p>回调函数如果返回 true, 则不会再执行后面的代码.</p>
130
130
  *
131
- * @param cb 回调函数.
132
- * @param once 是否只会触发一次. 默认为 undefined.
131
+ * @param listener 事件监听函数.
132
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
133
133
  * @return {} 移除事件监听函数.
134
134
  */
135
- onAfterValidate(cb: IKgSubmitAfterValidateEventListener, once?: boolean): IRemoveEventListenerHandler;
135
+ onAfterValidate(listener: IKgSubmitAfterValidateEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
136
136
  /**
137
- * <p>事件: 点击确认按钮之后, 执行默认逻辑之前.</p>
137
+ * <p>监听事件: 点击确认按钮之后, 执行默认逻辑之前.</p>
138
138
  * <ul>
139
139
  * <li>可以在此时修改表单数据对象,</li>
140
140
  * <li>可以在此时修改表单验证规则,</li>
141
141
  * </ul>
142
142
  * <p>回调函数如果返回 true, 则不会再执行后面的代码.</p>
143
143
  *
144
- * @param cb 回调函数.
145
- * @param once 是否只会触发一次. 默认为 undefined.
144
+ * @param listener 事件监听函数.
145
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
146
146
  * @return {} 移除事件监听函数.
147
147
  */
148
- onBeforeOk(cb: IKgSubmitBeforeOkEventListener, once?: boolean): IRemoveEventListenerHandler;
148
+ onBeforeOk(listener: IKgSubmitBeforeOkEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
149
149
  /**
150
- * <p>事件: 打开提交弹窗之前.</p>
151
- * @param cb 回调函数.
152
- * @param once 是否只会触发一次. 默认为 undefined.
150
+ * <p>监听事件: 打开提交弹窗之前.</p>
151
+ * @param listener 事件监听函数.
152
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
153
153
  * @return {} 移除事件监听函数.
154
154
  */
155
- onBeforeOpen(cb: IKgSubmitBeforeOpenEventListener, once?: boolean): IRemoveEventListenerHandler;
155
+ onBeforeOpen(listener: IKgSubmitBeforeOpenEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
156
156
  /**
157
- * <p>事件: 发起接口请求之前. 表单验证完成, 参数解析完成.</p>
157
+ * <p>监听事件: 发起接口请求之前. 表单验证完成, 参数解析完成.</p>
158
158
  * <p>回调函数如果返回 true, 则不会再执行后面的代码.</p>
159
159
  *
160
- * @param cb 回调函数.
161
- * @param once 是否只会触发一次. 默认为 undefined.
160
+ * @param listener 事件监听函数.
161
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
162
162
  * @return {} 移除事件监听函数.
163
163
  */
164
- onBeforeRequest(cb: IKgSubmitBeforeRequestEventListener, once?: boolean): IRemoveEventListenerHandler;
164
+ onBeforeRequest(listener: IKgSubmitBeforeRequestEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
165
165
  /**
166
- * <p>事件: 关闭提交弹窗. 下面几种场景都会触发此事件:</p>
166
+ * <p>监听事件: 关闭提交弹窗. 下面几种场景都会触发此事件:</p>
167
167
  * <ul>
168
168
  * <li>点击右上角的关闭按钮,</li>
169
169
  * <li>点击取消按钮,</li>
170
170
  * <li>点击保存按钮之后, 调用接口成功, 关闭弹窗,</li>
171
171
  * </ul>
172
- * @param cb 回调函数.
173
- * @param once 是否只会触发一次. 默认为 undefined.
172
+ * @param listener 事件监听函数.
173
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
174
174
  * @return {} 移除事件监听函数.
175
175
  */
176
- onClose(cb: IKgSubmitCloseEventListener, once?: boolean): IRemoveEventListenerHandler;
176
+ onClose(listener: IKgSubmitCloseEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
177
177
  /**
178
- * <p>事件: 请求失败. 请求失败了, 或者请求返回了错误消息.</p>
179
- * @param cb 回调函数.
180
- * @param once 是否只会触发一次. 默认为 undefined.
178
+ * <p>监听事件: 请求失败. 请求失败了, 或者请求返回了错误消息.</p>
179
+ * @param listener 事件监听函数.
180
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
181
181
  * @return {} 移除事件监听函数.
182
182
  */
183
- onError(cb: IKgSubmitErrorEventListener, once?: boolean): IRemoveEventListenerHandler;
183
+ onError(listener: IKgSubmitErrorEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
184
184
  /**
185
- * <p>事件: 点击保存按钮之后, 执行默认逻辑之后, 调用接口成功, 关闭提交弹窗之后.</p>
186
- * @param cb 回调函数.
187
- * @param once 是否只会触发一次. 默认为 undefined.
185
+ * <p>监听事件: 点击保存按钮之后, 执行默认逻辑之后, 调用接口成功, 关闭提交弹窗之后.</p>
186
+ * @param listener 事件监听函数.
187
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
188
188
  * @return {} 移除事件监听函数.
189
189
  */
190
- onOk(cb: IKgSubmitOkEventListener, once?: boolean): IRemoveEventListenerHandler;
190
+ onOk(listener: IKgSubmitOkEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
191
191
  /**
192
- * <p>事件: 打开提交弹窗.</p>
193
- * @param cb 回调函数.
194
- * @param once 是否只会触发一次. 默认为 undefined.
192
+ * <p>监听事件: 打开提交弹窗.</p>
193
+ * @param listener 事件监听函数.
194
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
195
195
  * @return {} 移除事件监听函数.
196
196
  */
197
- onOpen(cb: IKgSubmitOpenEventListener, once?: boolean): IRemoveEventListenerHandler;
197
+ onOpen(listener: IKgSubmitOpenEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
198
198
  /**
199
199
  * <p>修改某个「提交表单字段」的部分属性.</p>
200
200
  * <p>如果参数 param.buttonType 和 param.buttonVarName 都为 undefined, 表示修改的是「当前按钮」的「提交表单字段」.</p>
201
201
  *
202
- * @param param.buttonType <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG_BUTTON_TYPE}.</p>
202
+ * @param param.buttonType <p>按钮的类型, 对应的是 {@link VarButton.typ} 属性, 取值请参考 {@link KG__VAR_BUTTON__TYPE}.</p>
203
203
  * @param param.buttonVarName <p>按钮的变量名称, 对应的是 {@link VarButton.var_nam} 属性.</p>
204
204
  * @param param.properties 要修改的部分属性.
205
205
  * @param param.varName 「提交表单字段」的变量名称, 对应的是 {@link VarSubmitDetail.var_nam} 属性.
206
206
  */
207
207
  patchVarSubmitDetail(param: {
208
- buttonType?: KG_BUTTON_TYPE;
208
+ buttonType?: KG__VAR_BUTTON__TYPE;
209
209
  buttonVarName?: string | null;
210
210
  properties: VarSubmitDetail;
211
211
  varName: string | null | undefined;
@@ -3,7 +3,7 @@ import { FormInstance } from 'ant-design-vue/lib/form/Form';
3
3
  import { StoreDefinition } from 'pinia';
4
4
  import { Ref } from 'vue';
5
5
  import { VarSubmitConfig, VarSubmitDetail } from '../../apis/WMS/models';
6
- import { IKgEventListener, KG_BUTTON_TYPE } from '../../consts';
6
+ import { IKgEventListener, KG__VAR_BUTTON__TYPE } from '../../consts';
7
7
  import { KgAny } from '../../types';
8
8
  import { IKgTableRow } from '../KgTable';
9
9
  /**
@@ -141,11 +141,11 @@ export interface IUseKgSubmitStoreGetters {
141
141
  getFormRef(): (formID?: string | null) => Ref<FormInstance | null>;
142
142
  getFormRules(): (formID?: string | null) => Ref<Record<string, Array<RuleObject>>>;
143
143
  getVarSubmitConfig(): (formID: string | null | undefined, param?: {
144
- buttonType?: KG_BUTTON_TYPE;
144
+ buttonType?: KG__VAR_BUTTON__TYPE;
145
145
  buttonVarName?: string | null;
146
146
  }) => VarSubmitConfig | null;
147
147
  getVarSubmitDetails(): (formID: string | null | undefined, param?: {
148
- buttonType?: KG_BUTTON_TYPE;
148
+ buttonType?: KG__VAR_BUTTON__TYPE;
149
149
  buttonVarName?: string | null;
150
150
  isKey?: 0 | 1 | null;
151
151
  isVisible?: 0 | 1 | null;
@@ -159,9 +159,9 @@ export interface IUseKgSubmitStoreActions {
159
159
  * 注册事件监听.
160
160
  * @param formID 界面标识.
161
161
  * @param event 事件名称.
162
- * @param cb 回调函数.
162
+ * @param listener 事件监听函数.
163
163
  */
164
- addEventListener(formID: string, event: IKgSubmitEvent, cb: IKgSubmitEventListener): void;
164
+ addEventListener(formID: string, event: IKgSubmitEvent, listener: IKgSubmitEventListener): void;
165
165
  /**
166
166
  * 清理数据.
167
167
  * @param formID 页面标识.
@@ -169,7 +169,7 @@ export interface IUseKgSubmitStoreActions {
169
169
  dispose(formID?: string | null): void;
170
170
  emit<T = IKgSubmitEventListenerParameter>(formID: string, event: IKgSubmitEvent, param: T): Promise<boolean>;
171
171
  patchVarSubmitDetail(formID: string | null | undefined, param: {
172
- buttonType?: KG_BUTTON_TYPE;
172
+ buttonType?: KG__VAR_BUTTON__TYPE;
173
173
  buttonVarName?: string | null;
174
174
  properties: VarSubmitDetail;
175
175
  varName: string | null | undefined;
@@ -178,9 +178,9 @@ export interface IUseKgSubmitStoreActions {
178
178
  * 退订事件监听.
179
179
  * @param formID 界面标识.
180
180
  * @param event 事件名称.
181
- * @param cb 回调函数.
181
+ * @param listener 事件监听函数.
182
182
  */
183
- removeEventListener(formID: string, event: IKgSubmitEvent, cb?: IKgSubmitEventListener): void;
183
+ removeEventListener(formID: string, event: IKgSubmitEvent, listener?: IKgSubmitEventListener): void;
184
184
  setFormModel(formID?: string | null, model?: Record<string, any> | null): void;
185
185
  setIsLoading(formID: string, value: boolean): void;
186
186
  }
@@ -24,8 +24,8 @@ export interface IUseKgTable {
24
24
  /**
25
25
  * <p>是否显示描述.</p>
26
26
  * <ul>
27
- * <li>是: 所有描述列(即显示类型为 {@link KG_TABLE_CELL_DISPLAY_TYPE.DESC} 的列)显示的是描述,</li>
28
- * <li>否: 所有描述列(即显示类型为 {@link KG_TABLE_CELL_DISPLAY_TYPE.DESC} 的列)显示的是原始的值,</li>
27
+ * <li>是: 所有描述列(即显示类型为 {@link KG__VAR_GRID_DETAIL__DISPLAY_TYPE.DESC} 的列)显示的是描述,</li>
28
+ * <li>否: 所有描述列(即显示类型为 {@link KG__VAR_GRID_DETAIL__DISPLAY_TYPE.DESC} 的列)显示的是原始的值,</li>
29
29
  * </ul>
30
30
  *
31
31
  * @default true
@@ -34,55 +34,55 @@ export interface IUseKgTable {
34
34
  /** 查询条件的界面标识. */
35
35
  kgSearchFormID: ComputedRef<string>;
36
36
  /**
37
- * 事件: 查询请求成功, 表格数据已经赋值, 表格状态已经更新.
38
- * @param cb 回调函数.
39
- * @param once 是否只会触发一次. 默认为 undefined.
37
+ * 监听事件: 查询请求成功, 表格数据已经赋值, 表格状态已经更新.
38
+ * @param listener 事件监听函数.
39
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
40
40
  */
41
- onAfterSearch(cb: IKgTableAfterRequestEventListener, once?: boolean): IRemoveEventListenerHandler;
41
+ onAfterSearch(listener: IKgTableAfterRequestEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
42
42
  /**
43
- * 事件: 即将解析请求参数.
44
- * @param cb 回调函数.
45
- * @param once 是否只会触发一次. 默认为 undefined.
43
+ * 监听事件: 即将解析请求参数.
44
+ * @param listener 事件监听函数.
45
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
46
46
  */
47
- onBeforeParseParameter(cb: IKgTableBeforeParseParameterEventListener, once?: boolean): IRemoveEventListenerHandler;
47
+ onBeforeParseParameter(listener: IKgTableBeforeParseParameterEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
48
48
  /**
49
- * 事件: 即将发起查询请求, 如果返回 true 表示不会发起请求.
50
- * @param cb 回调函数.
51
- * @param once 是否只会触发一次. 默认为 undefined.
49
+ * 监听事件: 即将发起查询请求, 如果返回 true 表示不会发起请求.
50
+ * @param listener 事件监听函数.
51
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
52
52
  * @deprecated 已废弃, 请使用 onBeforeSearch() 方法.
53
53
  */
54
- onBeforeRetrieve(cb: IKgTableBeforeRequestEventListener, once?: boolean): IRemoveEventListenerHandler;
54
+ onBeforeRetrieve(listener: IKgTableBeforeRequestEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
55
55
  /**
56
- * 事件: 即将发起查询请求, 如果返回 true 表示不会发起请求.
57
- * @param cb 回调函数.
58
- * @param once 是否只会触发一次. 默认为 undefined.
56
+ * 监听事件: 即将发起查询请求, 如果返回 true 表示不会发起请求.
57
+ * @param listener 事件监听函数.
58
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
59
59
  */
60
- onBeforeSearch(cb: IKgTableBeforeRequestEventListener, once?: boolean): IRemoveEventListenerHandler;
60
+ onBeforeSearch(listener: IKgTableBeforeRequestEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
61
61
  /**
62
- * 事件: 查询请求成功, 表格数据尚未赋值. 此处可以对查询接口返回的列表数据作处理.
63
- * @param cb 回调函数.
64
- * @param once 是否只会触发一次. 默认为 undefined.
62
+ * 监听事件: 查询请求成功, 表格数据尚未赋值. 此处可以对查询接口返回的列表数据作处理.
63
+ * @param listener 事件监听函数.
64
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
65
65
  */
66
- onBeforeSetDatas(cb: IKgTableBeforeSetDatasEventListener, once?: boolean): IRemoveEventListenerHandler;
66
+ onBeforeSetDatas(listener: IKgTableBeforeSetDatasEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
67
67
  /**
68
- * 事件: ready, 配置初始完成, 组件渲染完成.
69
- * @param cb 回调函数.
70
- * @param once 是否只会触发一次. 默认为 undefined.
68
+ * 监听事件: ready, 配置初始完成, 组件渲染完成.
69
+ * @param listener 事件监听函数.
70
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
71
71
  */
72
- onReady(cb: IKgTableReadyEventListener, once?: boolean): IRemoveEventListenerHandler;
72
+ onReady(listener: IKgTableReadyEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
73
73
  /**
74
- * 事件: 查询请求成功, 表格数据已经赋值, 表格状态已经更新.
75
- * @param cb 回调函数.
76
- * @param once 是否只会触发一次. 默认为 undefined.
74
+ * 监听事件: 查询请求成功, 表格数据已经赋值, 表格状态已经更新.
75
+ * @param listener 事件监听函数.
76
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
77
77
  * @deprecated 已废弃, 请使用 onAfterSearch() 方法.
78
78
  */
79
- onRetrieve(cb: IKgTableAfterRequestEventListener, once?: boolean): IRemoveEventListenerHandler;
79
+ onRetrieve(listener: IKgTableAfterRequestEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
80
80
  /**
81
- * 事件: 双击某行.
82
- * @param cb 回调函数.
83
- * @param once 是否只会触发一次. 默认为 undefined.
81
+ * 监听事件: 双击某行.
82
+ * @param listener 事件监听函数.
83
+ * @param isOnce 是否只会触发一次. 默认为 undefined.
84
84
  */
85
- onRowDoubleClick(cb: IKgTableRowDoubleClickEventListener, once?: boolean): IRemoveEventListenerHandler;
85
+ onRowDoubleClick(listener: IKgTableRowDoubleClickEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
86
86
  /** 当前分页选项. */
87
87
  pageSizeOption: ComputedRef<number>;
88
88
  /** 所有分页选项. */
@@ -36,8 +36,14 @@ export declare type IKgTableBeforeRequestEventListenerParameter = {
36
36
  };
37
37
  export declare type IKgTableBeforeRequestEventListener = ((param: IKgTableBeforeRequestEventListenerParameter) => Promise<boolean>) & IKgEventListener;
38
38
  export declare type IKgTableBeforeSetDatasEventListenerParameter = {
39
- /** 列表数据. */
39
+ /**
40
+ * 列表数据.
41
+ */
40
42
  datas: Ref<Array<IKgTableRow>>;
43
+ /**
44
+ * 数据总数.
45
+ */
46
+ total: Ref<Number>;
41
47
  };
42
48
  export declare type IKgTableBeforeSetDatasEventListener = ((param: IKgTableBeforeSetDatasEventListenerParameter) => Promise<boolean>) & IKgEventListener;
43
49
  export declare type IKgTableAfterRequestEventListenerParameter = {
@@ -76,7 +82,7 @@ export interface IUseKgTableStoreState {
76
82
  * <li>是: 所有描述列显示的是描述,</li>
77
83
  * <li>否: 所有描述列显示的是原始的值,</li>
78
84
  * </ul>
79
- * <p>描述列指的是显示类型为 KG_TABLE_CELL_DISPLAY_TYPE.DESC 的列.</p>
85
+ * <p>描述列指的是显示类型为 KG__VAR_GRID_DETAIL__DISPLAY_TYPE.DESC 的列.</p>
80
86
  *
81
87
  * @default true
82
88
  */
@@ -136,9 +142,9 @@ export interface IUseKgTableStoreActions {
136
142
  * 注册事件监听.
137
143
  * @param formID 界面标识.
138
144
  * @param event 事件名称.
139
- * @param cb 回调函数.
145
+ * @param listener 事件监听函数.
140
146
  */
141
- addEventListener(formID: string | null | undefined, event: IKgTableEvent, cb: IKgTableEventListener): void;
147
+ addEventListener(formID: string | null | undefined, event: IKgTableEvent, listener: IKgTableEventListener): void;
142
148
  /**
143
149
  * 修改「表格配置」的部分属性.
144
150
  *
@@ -175,9 +181,9 @@ export interface IUseKgTableStoreActions {
175
181
  * 退订事件监听.
176
182
  * @param formID 界面标识.
177
183
  * @param event 事件名称.
178
- * @param cb 回调函数.
184
+ * @param listener 事件监听函数.
179
185
  */
180
- removeEventListener(formID: string | null | undefined, event: IKgTableEvent, cb?: IKgTableEventListener): void;
186
+ removeEventListener(formID: string | null | undefined, event: IKgTableEvent, listener?: IKgTableEventListener): void;
181
187
  /**
182
188
  * 设置列表数据.
183
189
  * @param param.frmId 界面标识.