@kengic/vue 0.22.0 → 0.23.0

package/CHANGELOG.md

@@ -1,177 +1,216 @@
-# 0.xx.0
+# 0.23.0
+
+### 1. 修改组件 API 的获取方式, 由方法改为属性,
+
+```typescript
+// 旧
+// --------------------------------------------------
+const kgVar = useKgVar();
+
+kgVar.xxx;
+kgVar.kgButton().xxx;
+kgVar.kgForm().xxx;
+kgVar.kgSearch().xxx;
+kgVar.kgSubmit().xxx;
+kgVar.kgTable().xxx;
+
+// 新
+// --------------------------------------------------
+const kgVar = useKgVar();
+
+kgVar.xxx;
+kgVar.kgButton.xxx;
+kgVar.kgForm.xxx;
+kgVar.kgSearch.xxx;
+kgVar.kgSubmit.xxx;
+kgVar.kgTable.xxx;
+```
+
+# 0.22.0
+
+### 1. 重命名类
 
-1.  重命名类
+| 旧                     | 新                   |
+| :--------------------- | :------------------- |
+| VarContext             | VarVariable          |
+| VarVariableConfig      | VarConfigControl     |
+| VarVariableCatalog     | VarConfigDescription |
+| VarVariableInput       | VarConfigInput       |
+| VarVariableLookup      | VarConfigLookup      |
+| VarVariablePossibility | VarConfigPossibility |
+| VarSubmitField         | VarSubmitDetail      |
 
-    | 旧                     | 新                   |
-    | :--------------------- | :------------------- |
-    | VarContext             | VarVariable          |
-    | VarVariableConfig      | VarConfigControl     |
-    | VarVariableCatalog     | VarConfigDescription |
-    | VarVariableInput       | VarConfigInput       |
-    | VarVariableLookup      | VarConfigLookup      |
-    | VarVariablePossibility | VarConfigPossibility |
-    | VarSubmitField         | VarSubmitDetail      |
+### 2. 重命名表
 
-2.  重命名表
+| 旧          | 新                     |
+| :---------- | :--------------------- |
+| var_ctx     | var_variable           |
+| var_btn     | var_button             |
+| var_cfg     | var_config_control     |
+| var_cat     | var_config_description |
+| var_var_ipt | var_config_input       |
+| var_lkp     | var_config_lookup      |
+| var_psb     | var_config_possibility |
+| var_grd_cfg | var_grid_config        |
+| var_grd_dtl | var_grid_detail        |
+| var_grd_mst | var_grid_master        |
+| var_prf_cfg | var_profile_config     |
+| var_prf_dtl | var_profile_detail     |
+| var_prf_mst | var_profile_master     |
+| var_sbt_cfg | var_submit_config      |
+| var_sbt_fld | var_submit_detail      |
 
-    | 旧          | 新                     |
-    | :---------- | :--------------------- |
-    | var_ctx     | var_variable           |
-    | var_btn     | var_button             |
-    | var_cfg     | var_config_control     |
-    | var_cat     | var_config_description |
-    | var_var_ipt | var_config_input       |
-    | var_lkp     | var_config_lookup      |
-    | var_psb     | var_config_possibility |
-    | var_grd_cfg | var_grid_config        |
-    | var_grd_dtl | var_grid_detail        |
-    | var_grd_mst | var_grid_master        |
-    | var_prf_cfg | var_profile_config     |
-    | var_prf_dtl | var_profile_detail     |
-    | var_prf_mst | var_profile_master     |
-    | var_sbt_cfg | var_submit_config      |
-    | var_sbt_fld | var_submit_detail      |
+### 3. `KgSearch`,`KgButton`,`KgTable`,`KgSubmit` 等组件的 API 不用再单独获取, 可以直接从 `kgVar` 中获取,
 
-3.  `KgSearch`,`KgButton`,`KgTable`,`KgSubmit` 等组件的 API 不用再单独获取, 可以直接从 `kgVar` 中获取,
+```typescript
+// 旧
+// --------------------------------------------------
+const kgVar = useKgVar();
+const kgButton = usekgButton();
+const kgForm = usekgForm();
+const kgSearch = useKgSearch();
+const kgSubmit = useKgSubmit();
+const kgTable = useKgTable();
 
-    ```typescript
-    // 旧
-    // --------------------------------------------------
-    const kgVar = useKgVar();
-    const kgSearch = useKgSearch();
-    const kgButton = usekgButton();
-    // ...
+kgVar.xxx;
+kgButton.xxx;
+kgForm.xxx;
+kgSearch.xxx;
+kgSubmit.xxx;
+kgTable.xxx;
 
-    kgVar.onRetrieve();
-    kgSearch.onSearch();
-    kgButton.onClick();
-    // ...
+// 新
+// --------------------------------------------------
+const kgVar = useKgVar();
 
-    // 新
-    // --------------------------------------------------
-    const kgVar = useKgVar();
+kgVar.xxx;
+kgVar.kgButton().xxx;
+kgVar.kgForm().xxx;
+kgVar.kgSearch().xxx;
+kgVar.kgSubmit().xxx;
+kgVar.kgTable().xxx;
+```
 
-    kgVar.onRetrieve();
-    kgVar.kgSearch().onSearch();
-    kgVar.kgButton().onClick();
-    // ...
-    ```
+### 4. `kgVar` 中的部分方法移到对应的组件的 API 中并且重命名:
 
-4.  `kgVar` 中的部分方法移到对应的组件的 API 中并且重命名:
+#### 4.1. kgButton
 
-    4.1. kgButton
+`kgVar.setIsCreating(true)` 变更为 `kgVar.kgButton.setCurrentButton({ type: KG_BUTTON_TYPE.CREATE });`
 
-         `kgVar.setIsCreating(true)` 变更为 `kgVar.kgButton().setCurrentButton({ type: KG_BUTTON_TYPE.CREATE });`
+`kgVar.setIsUpdating(true)` 变更为 `kgVar.kgButton.setCurrentButton({ type: KG_BUTTON_TYPE.UPDATE });`
 
-         `kgVar.setIsUpdating(true)` 变更为 `kgVar.kgButton().setCurrentButton({ type: KG_BUTTON_TYPE.UPDATE });`
+`kgVar.setIsCopying(true)` 变更为 `kgVar.kgButton.setCurrentButton({ type: KG_BUTTON_TYPE.COPY });`
+
+`kgVar.setIsDeleting(true)` 变更为 `kgVar.kgButton.setCurrentButton({ type: KG_BUTTON_TYPE.DELETE });`
+
+`kgVar.setIsCreating(false)` 变更为 `kgVar.kgButton.setCurrentButton(null);`
+
+`kgVar.setIsUpdating(false)` 变更为 `kgVar.kgButton.setCurrentButton(null);`
 
-         `kgVar.setIsCopying(true)` 变更为 `kgVar.kgButton().setCurrentButton({ type: KG_BUTTON_TYPE.COPY });`
+`kgVar.setIsCopying(false)` 变更为 `kgVar.kgButton.setCurrentButton(null);`
+
+`kgVar.setIsDeleting(false)` 变更为 `kgVar.kgButton.setCurrentButton(null);`
 
-         `kgVar.setIsDeleting(true)` 变更为 `kgVar.kgButton().setCurrentButton({ type: KG_BUTTON_TYPE.DELETE });`
+#### 4.2. kgSubmit
 
-         `kgVar.setIsCreating(false)` 变更为 `kgVar.kgButton().setCurrentButton(null);`
+`kgVar.patchVarSubmitField()` 变更为 `kgVar.kgSubmit.patchVarSubmitDetail()`
 
-         `kgVar.setIsUpdating(false)` 变更为 `kgVar.kgButton().setCurrentButton(null);`
+`kgButton.onDeleteOk()` 变更为 `kgVar.kgSubmit.onOk()`
 
-         `kgVar.setIsCopying(false)` 变更为 `kgVar.kgButton().setCurrentButton(null);`
+### 5. kgVar.kgButton.onClick() 事件回调函数参数类型变更,
 
-         `kgVar.setIsDeleting(false)` 变更为 `kgVar.kgButton().setCurrentButton(null);`
+```typescript
+// 旧
+// --------------------------------------------------
+kgVar.kgButton.onClick(async (button) => {});
 
-    4.2. kgSubmit
-
-         `kgVar.patchVarSubmitField()` 变更为 `kgVar.kgSubmit().patchVarSubmitDetail()`
-
----
+// 新
+// --------------------------------------------------
+kgVar.kgButton.onClick(async ({ button }) => {});
+```
 
 # 0.21.0
 
-1. 查询条件中的日期范围, 对右侧的日期做了处理, 如果格式是 `YYYY-MM-DD` 则加上一天, 如果格式是 `YYYY-MM-DD HH:mm:ss` 则加上一秒,
-
----
+### 1. 查询条件中的日期范围, 对右侧的日期做了处理, 如果格式是 `YYYY-MM-DD` 则加上一天, 如果格式是 `YYYY-MM-DD HH:mm:ss` 则加上一秒,
 
 # 0.20.0
 
-1. `kg-search-header-teleport` 重命名为 `kg-layout-header-teleport`,
-2. 添加配置 `IKgOption.KgLayoutTab.isTeleportToHeader` 并且默认为 `true`, 即多标签页默认会放到页面头部,
+### 1. `kg-search-header-teleport` 重命名为 `kg-layout-header-teleport`,
 
----
+### 2. 添加配置 `IKgOption.KgLayoutTab.isTeleportToHeader` 并且默认为 `true`, 即多标签页默认会放到页面头部,
 
 # 0.19.0
 
-1. 支持新版本的 DDA 的创建, 需要更新数据 `20240401000000000.sql`
-
----
+### 1. 支持新版本的 DDA 的创建, 需要更新数据 `20240401000000000.sql`
 
 # 0.18.0
 
-1. `kgTable.store.setDatas()` 方法参数类型变更,
-
-    ```typescript
-    // 旧
-    // --------------------------------------------------
-    kgTable.store.setDatas(frmId, datas);
-
-    // 新
-    // --------------------------------------------------
-    kgTable.store.setDatas({ frmId: frmId, datas: datas });
-    ```
-
-2. 移除 `kgTable.onBeforeSetDatas()` 事件回调函数参数中的 `setDatas` 方法, 改为直接调用 `kgTable.store.setDatas()` 方法,
-
-    ```typescript
-    // 旧
-    // --------------------------------------------------
-    kgTable.onBeforeSetDatas(async ({ datas, setDatas }) => {
-        setDatas([]);
+### 1. `kgTable.store.setDatas()` 方法参数类型变更,
+
+```typescript
+// 旧
+// --------------------------------------------------
+kgTable.store.setDatas(frmId, datas);
+
+// 新
+// --------------------------------------------------
+kgTable.store.setDatas({ frmId: frmId, datas: datas });
+```
+
+### 2. 移除 `kgTable.onBeforeSetDatas()` 事件回调函数参数中的 `setDatas` 方法, 改为直接调用 `kgTable.store.setDatas()` 方法,
+
+```typescript
+// 旧
+// --------------------------------------------------
+kgTable.onBeforeSetDatas(async ({ datas, setDatas }) => {
+    setDatas([]);
+});
+
+// 新
+// --------------------------------------------------
+kgTable.onBeforeSetDatas(async ({ datas }) => {
+    kgTable.store.setDatas({
+        frmId: '',
+        datas: [],
     });
-
-    // 新
-    // --------------------------------------------------
-    kgTable.onBeforeSetDatas(async ({ datas }) => {
-        kgTable.store.setDatas({
-            frmId: '',
-            datas: [],
-        });
+});
+```
+
+### 3. 移除 `kgTable.onAfterSearch()` 事件回调函数参数中的 `setDatas` 方法, 改为直接调用 `kgTable.store.setDatas()` 方法,
+
+```typescript
+// 旧
+// --------------------------------------------------
+kgTable.onAfterSearch(async ({ datas, setDatas }) => {
+    setDatas([]);
+});
+
+// 新
+// --------------------------------------------------
+kgTable.onAfterSearch(async ({ datas }) => {
+    kgTable.store.setDatas({
+        frmId: '',
+        datas: [],
     });
-    ```
-
-3. 移除 `kgTable.onAfterSearch()` 事件回调函数参数中的 `setDatas` 方法, 改为直接调用 `kgTable.store.setDatas()` 方法,
-
-    ```typescript
-    // 旧
-    // --------------------------------------------------
-    kgTable.onAfterSearch(async ({ datas, setDatas }) => {
-        setDatas([]);
-    });
-
-    // 新
-    // --------------------------------------------------
-    kgTable.onAfterSearch(async ({ datas }) => {
-        kgTable.store.setDatas({
-            frmId: '',
-            datas: [],
-        });
-    });
-    ```
-
----
+});
+```
 
 # 0.17.0
 
-1. `kgForm.onSelectChange()` 事件回调函数参数类型变更,
-
-    ```typescript
-    // 旧
-    // --------------------------------------------------
-    kgForm.onSelectChange(async ({ rows }) => {
-        // rows 是单个对象
-        const item = rows as any;
-    });
-
-    // 新
-    // --------------------------------------------------
-    kgForm.onSelectChange(async ({ rows }) => {
-        // rows 是数组
-        const item = rows?.[0] as any;
-    });
-    ```
+### 1. `kgForm.onSelectChange()` 事件回调函数参数类型变更,
+
+```typescript
+// 旧
+// --------------------------------------------------
+kgForm.onSelectChange(async ({ rows }) => {
+    // rows 是单个对象
+    const item = rows as any;
+});
+
+// 新
+// --------------------------------------------------
+kgForm.onSelectChange(async ({ rows }) => {
+    // rows 是数组
+    const item = rows?.[0] as any;
+});
+```