@ibiz-template/vue3-components 0.0.1-alpha.1 → 0.0.1-alpha.3

package/es/control/grid/grid/grid-column.controller.d.ts

@@ -0,0 +1,76 @@
+import { IDEGridColumn } from '@ibiz/model-core';
+import { GridController } from './grid.controller';
+/**
+ * 表格列控制器
+ * @return {*}
+ * @author: zhujiamin
+ * @Date: 2022-09-01 18:25:20
+ */
+export declare class GridColumnController<T extends IDEGridColumn = IDEGridColumn> {
+    /**
+     * 表格列模型对象
+     *
+     * @author lxm
+     * @date 2022-09-05 19:09:07
+     * @type {T}
+     */
+    readonly model: T;
+    /**
+     * 表单控制器
+     *
+     * @author lxm
+     * @date 2022-08-24 22:08:59
+     * @type {GridController}
+     */
+    readonly grid: GridController;
+    /**
+     * 上下文
+     *
+     * @author lxm
+     * @date 2022-09-05 19:09:24
+     * @readonly
+     * @type {IContext}
+     */
+    get context(): IContext;
+    /**
+     * 视图参数
+     *
+     * @author lxm
+     * @date 2022-09-05 19:09:00
+     * @readonly
+     * @type {IParams}
+     */
+    get params(): IParams;
+    /**
+     * 该列是否启用行编辑
+     *
+     * @author lxm
+     * @date 2022-09-06 11:09:58
+     * @readonly
+     */
+    get enableRowEdit(): boolean | undefined;
+    /**
+     * Creates an instance of GridFieldColumnController.
+     * @author lxm
+     * @date 2022-08-24 20:08:22
+     * @param {T} model
+     */
+    constructor(model: T, grid: GridController);
+    /**
+     * 子类不可覆盖或重写此方法，在 init 时需要重写的使用 onInit 方法。
+     *
+     * @author lxm
+     * @date 2022-08-18 22:08:30
+     * @returns {*}  {Promise<void>}
+     */
+    init(): Promise<void>;
+    /**
+     * 初始化方法
+     *
+     * @author lxm
+     * @date 2022-09-28 15:09:15
+     * @protected
+     * @returns {*}  {Promise<void>}
+     */
+    protected onInit(): Promise<void>;
+}

package/es/control/grid/grid/grid-column.controller.js

@@ -0,0 +1,89 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class GridColumnController {
+  /**
+   * Creates an instance of GridFieldColumnController.
+   * @author lxm
+   * @date 2022-08-24 20:08:22
+   * @param {T} model
+   */
+  constructor(model, grid) {
+    /**
+     * 表格列模型对象
+     *
+     * @author lxm
+     * @date 2022-09-05 19:09:07
+     * @type {T}
+     */
+    __publicField(this, "model");
+    /**
+     * 表单控制器
+     *
+     * @author lxm
+     * @date 2022-08-24 22:08:59
+     * @type {GridController}
+     */
+    __publicField(this, "grid");
+    this.model = model;
+    this.grid = grid;
+  }
+  /**
+   * 上下文
+   *
+   * @author lxm
+   * @date 2022-09-05 19:09:24
+   * @readonly
+   * @type {IContext}
+   */
+  get context() {
+    return this.grid.context;
+  }
+  /**
+   * 视图参数
+   *
+   * @author lxm
+   * @date 2022-09-05 19:09:00
+   * @readonly
+   * @type {IParams}
+   */
+  get params() {
+    return this.grid.params;
+  }
+  /**
+   * 该列是否启用行编辑
+   *
+   * @author lxm
+   * @date 2022-09-06 11:09:58
+   * @readonly
+   */
+  get enableRowEdit() {
+    return this.grid.model.enableRowEdit && this.model.enableRowEdit;
+  }
+  /**
+   * 子类不可覆盖或重写此方法，在 init 时需要重写的使用 onInit 方法。
+   *
+   * @author lxm
+   * @date 2022-08-18 22:08:30
+   * @returns {*}  {Promise<void>}
+   */
+  async init() {
+    await this.onInit();
+  }
+  /**
+   * 初始化方法
+   *
+   * @author lxm
+   * @date 2022-09-28 15:09:15
+   * @protected
+   * @returns {*}  {Promise<void>}
+   */
+  async onInit() {
+  }
+}
+export {
+  GridColumnController
+};

package/{lib/control/grid-control → es/control/grid/grid}/grid-control.util.d.ts

@@ -1,4 +1,5 @@
-import { GridController, ControlVO } from '@ibiz-template/runtime';
+import { ControlVO } from '@ibiz-template/runtime';
+import { GridController } from './grid.controller';
 /**
  * 适配element的table的事件
  *
@@ -9,7 +10,7 @@ import { GridController, ControlVO } from '@ibiz-template/runtime';
  * @returns {*}
  */
 export declare function useITableEvent(c: GridController): {
-    tableRef: import("vue").Ref<any>;
+    tableRef: import("vue").Ref<IData | undefined>;
     onRowClick: (data: ControlVO) => void;
     onDbRowClick: (data: ControlVO) => void;
     onSelectionChange: (selection: ControlVO[]) => void;

package/es/control/grid/grid/grid-row.controller.d.ts

@@ -0,0 +1,77 @@
+import { MDItemController, IButtonContainerState, ControlVO } from '@ibiz-template/runtime';
+import { GridController } from './grid.controller';
+/**
+ * 表格行数据状态管理控制器
+ *
+ * @author lxm
+ * @date 2022-09-05 19:09:02
+ * @export
+ * @class GridRowController
+ */
+export declare class GridRowController extends MDItemController {
+    /**
+     * 错误信息集合，p是对应属性名称
+     *
+     * @author lxm
+     * @date 2022-09-06 15:09:54
+     * @type {({ [p: string]: string | null })}
+     */
+    errors: {
+        [p: string]: string | null;
+    };
+    /**
+     * 操作列状态(p是操作列的标识)
+     *
+     * @author lxm
+     * @date 2022-09-07 22:09:38
+     * @type {({ [p: string]: IButtonContainerState | null })}
+     */
+    uaColumnStates: {
+        [p: string]: IButtonContainerState | null;
+    };
+    /**
+     * 每一列的状态
+     *
+     * @author lxm
+     * @date 2022-09-20 15:09:58
+     * @type {({ [p: string]: { disabled: boolean } | null })}
+     */
+    columnState: {
+        [p: string]: {
+            disabled: boolean;
+            editable: boolean;
+        } | null;
+    };
+    /**
+     * 是否显示行编辑
+     *
+     * @author lxm
+     * @date 2022-09-05 22:09:23
+     * @type {boolean}
+     */
+    showRowEdit: boolean;
+    /**
+     * 是否被修改过
+     *
+     * @author lxm
+     * @date 2022-11-02 22:11:33
+     * @type {boolean}
+     */
+    modified: boolean;
+    /**
+     * 是否正在处理中(动态控制，值规则，表单项更新等逻辑中)
+     * @author lxm
+     * @date 2023-03-06 08:00:22
+     * @type {boolean}
+     * @memberof GridRowController
+     */
+    processing: boolean;
+    constructor(data: ControlVO, grid: GridController);
+    /**
+     * 销毁方法
+     *
+     * @author lxm
+     * @date 2022-09-06 19:09:02
+     */
+    destroy(): void;
+}

package/es/control/grid/grid/grid-row.controller.js

@@ -0,0 +1,85 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+import { MDItemController, Srfuf } from "@ibiz-template/runtime";
+import { clearAll } from "qx-util";
+class GridRowController extends MDItemController {
+  constructor(data, grid) {
+    super(data, grid);
+    /**
+     * 错误信息集合，p是对应属性名称
+     *
+     * @author lxm
+     * @date 2022-09-06 15:09:54
+     * @type {({ [p: string]: string | null })}
+     */
+    __publicField(this, "errors", {});
+    /**
+     * 操作列状态(p是操作列的标识)
+     *
+     * @author lxm
+     * @date 2022-09-07 22:09:38
+     * @type {({ [p: string]: IButtonContainerState | null })}
+     */
+    __publicField(this, "uaColumnStates", {});
+    /**
+     * 每一列的状态
+     *
+     * @author lxm
+     * @date 2022-09-20 15:09:58
+     * @type {({ [p: string]: { disabled: boolean } | null })}
+     */
+    __publicField(this, "columnState", {});
+    /**
+     * 是否显示行编辑
+     *
+     * @author lxm
+     * @date 2022-09-05 22:09:23
+     * @type {boolean}
+     */
+    __publicField(this, "showRowEdit", false);
+    /**
+     * 是否被修改过
+     *
+     * @author lxm
+     * @date 2022-11-02 22:11:33
+     * @type {boolean}
+     */
+    __publicField(this, "modified", false);
+    /**
+     * 是否正在处理中(动态控制，值规则，表单项更新等逻辑中)
+     * @author lxm
+     * @date 2023-03-06 08:00:22
+     * @type {boolean}
+     * @memberof GridRowController
+     */
+    __publicField(this, "processing", false);
+    Object.keys(this.data).forEach((key) => {
+      if (this.errors[key] === void 0) {
+        this.errors[key] = null;
+      }
+    });
+    if (data.srfuf === Srfuf.CREATE) {
+      this.showRowEdit = true;
+    }
+    Object.values(grid.uaColumns).forEach((column) => {
+      column.initActionStates(this);
+    });
+  }
+  /**
+   * 销毁方法
+   *
+   * @author lxm
+   * @date 2022-09-06 19:09:02
+   */
+  destroy() {
+    super.destroy();
+    clearAll(this.errors);
+  }
+}
+export {
+  GridRowController
+};

package/es/control/grid/grid/grid-state.d.ts

@@ -0,0 +1,19 @@
+import { MDState } from '@ibiz-template/runtime';
+import { GridRowController } from './grid-row.controller';
+/**
+ * 表格部件UI状态
+ *
+ * @export
+ * @class GridState
+ * @extends {MDState}
+ */
+export declare class GridState extends MDState {
+    /**
+     * 表格行控制器
+     *
+     * @author lxm
+     * @date 2022-09-05 19:09:12
+     * @type {GridRowController[]}
+     */
+    rows: GridRowController[];
+}

package/es/control/grid/grid/grid-state.js

@@ -0,0 +1,23 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+import { MDState } from "@ibiz-template/runtime";
+class GridState extends MDState {
+  constructor() {
+    super(...arguments);
+    /**
+     * 表格行控制器
+     *
+     * @author lxm
+     * @date 2022-09-05 19:09:12
+     * @type {GridRowController[]}
+     */
+    __publicField(this, "rows", []);
+  }
+}
+export {
+  GridState
+};

package/es/control/grid/grid/grid.controller.d.ts

@@ -0,0 +1,225 @@
+import { IDEGrid, IDEGridColumn } from '@ibiz/model-core';
+import { ControllerEvent, ControlVO, GridNotifyState, GridService, IGridColumnProvider, IGridController, IGridEvent, MDController } from '@ibiz-template/runtime';
+import { GridFieldColumnController } from '../grid-field-column/grid-field-column.controller';
+import { GridColumnController } from './grid-column.controller';
+import { GridRowController } from './grid-row.controller';
+import { GridState } from './grid-state';
+import { GridUAColumnController } from '../grid-ua-column/grid-ua-column.controller';
+/**
+ * 表格控制器
+ *
+ * @author chitanda
+ * @date 2022-08-01 18:08:13
+ * @export
+ * @class GridController
+ * @extends {MDController<GridModel>}
+ */
+export declare class GridController extends MDController<IDEGrid> implements IGridController {
+    state: GridState;
+    evt: ControllerEvent<IGridEvent>;
+    /**
+     * 表格部件服务
+     *
+     * @author lxm
+     * @date 2022-08-19 13:08:51
+     * @type {EntityService}
+     */
+    service: GridService;
+    /**
+     * 所有表格列控制器集合
+     *
+     * @author lxm
+     * @date 2022-11-14 15:11:14
+     * @type {{ [key: string]: GridColumnController }}
+     */
+    columns: {
+        [key: string]: GridColumnController;
+    };
+    /**
+     * 所有表格属性列的控制器
+     *
+     * @author lxm
+     * @date 2022-08-24 20:08:07
+     * @type {{ [key: string]: GridFieldColumnController }}
+     */
+    fieldColumns: {
+        [key: string]: GridFieldColumnController;
+    };
+    /**
+     * 所有表格操作列的控制器
+     *
+     * @author lxm
+     * @date 2022-08-24 20:08:07
+     * @type {{ [key: string]: GridUAColumnController }}
+     */
+    uaColumns: {
+        [key: string]: GridUAColumnController;
+    };
+    /**
+     * 表格列的适配器
+     *
+     * @author lxm
+     * @date 2022-11-14 14:11:39
+     * @type {{ [key: string]: IGridColumnProvider }}
+     */
+    providers: {
+        [key: string]: IGridColumnProvider;
+    };
+    /**
+     * 表格行控制器
+     *
+     * @deprecated
+     * @author lxm
+     * @date 2022-09-05 19:09:12
+     * @type {GridRowController[]}
+     */
+    rows: GridRowController[];
+    /**
+     * 是否有配置宽度自适应列
+     *
+     * @type {boolean}
+     * @memberof GridController
+     */
+    hasWidthFlexGrow: boolean;
+    /**
+     * 是否默认禁用排序
+     *
+     * @author lxm
+     * @date 2022-09-28 11:09:48
+     * @readonly
+     */
+    get noSort(): boolean;
+    /**
+     * 初始化方法
+     *
+     * @author lxm
+     * @date 2022-08-18 22:08:17
+     * @protected
+     * @returns {*}  {Promise<void>}
+     */
+    protected doCreated(): Promise<void>;
+    /**
+     * 部件加载后处理
+     *
+     * @author lxm
+     * @date 2022-08-19 14:08:50
+     */
+    afterLoad(items: ControlVO[]): Promise<ControlVO[]>;
+    /**
+     * 后台删除结束后界面删除逻辑
+     *
+     * @author lxm
+     * @date 2022-09-06 19:09:10
+     * @param {IData} data
+     */
+    afterRemove(data: IData): void;
+    /**
+     * 新建行
+     *
+     * @author lxm
+     * @date 2022-09-06 21:09:05
+     */
+    newRow(): Promise<void>;
+    /**
+     * 保存
+     *
+     * @author lxm
+     * @date 2022-09-06 19:09:21
+     * @param {ControlVO} data
+     * @returns {*}  {Promise<void>}
+     */
+    save(data: ControlVO): Promise<void>;
+    /**
+     * 行单击事件
+     *
+     * @author lxm
+     * @date 2022-08-18 22:08:16
+     * @param {ControlVO} data 选中的单条数据
+     */
+    onRowClick(data: ControlVO): Promise<void>;
+    /**
+     * 行双击事件
+     *
+     * @author lxm
+     * @date 2022-08-18 22:08:16
+     * @param {ControlVO} data 选中的单条数据
+     */
+    onDbRowClick(data: ControlVO): Promise<void>;
+    /**
+     * 初始化表格属性列，操作列，编辑项控制器
+     *
+     * @author lxm
+     * @date 2022-08-24 21:08:48
+     * @protected
+     */
+    protected initColumnsController(column: IDEGridColumn): Promise<void>;
+    /**
+     * 初始化表格属性列，操作列，编辑项控制器
+     *
+     * @author lxm
+     * @date 2022-08-24 21:08:48
+     * @protected
+     */
+    protected initGridColumns(): Promise<void>;
+    /**
+     * 设置行属性的值
+     *
+     * @author lxm
+     * @date 2022-08-24 10:08:40
+     * @param {GridRowController} row 行状态控制器
+     * @param {unknown} value 要设置的值
+     * @param {string} name 要设置的表单数据的属性名称
+     */
+    setRowValue(row: GridRowController, name: string, value: unknown): Promise<void>;
+    /**
+     * 通知所有表格编辑项成员表格编辑项数据变更
+     *
+     * @author lxm
+     * @date 2022-09-20 22:09:49
+     * @param {GridRowController} row 行数据
+     * @param {string[]} names 更新的属性
+     */
+    dataChangeNotify(_row: GridRowController, _names: string[]): Promise<void>;
+    /**
+     * 表格状态变更通知
+     *
+     * @author lxm
+     * @date 2022-09-20 18:09:07
+     */
+    gridStateNotify(_row: GridRowController, _state: GridNotifyState): void;
+    /**
+     * 校验一行数据的所有编辑项
+     *
+     * @author lxm
+     * @date 2022-09-06 21:09:05
+     * @param {GridRowController} row 要校验的行数据控制器
+     * @returns {*}
+     */
+    validate(row: GridRowController): Promise<boolean>;
+    /**
+     * 切换行编辑，行编辑切换关闭前会校验并保存，如果失败则依然显示行编辑状态
+     *
+     * @author lxm
+     * @date 2022-09-08 11:09:55
+     * @param {GridRowController} row 行数据控制器
+     */
+    toggleRowEdit(row: GridRowController): Promise<void>;
+    /**
+     * 设置排序
+     *
+     * @author lxm
+     * @date 2022-09-28 13:09:44
+     * @param {string} key 排序字段
+     * @param {string} order 排序顺序
+     */
+    setSort(_key?: string, _order?: 'asc' | 'desc'): void;
+    /**
+     * 表格编辑项更新
+     *
+     * @author lxm
+     * @date 2022-09-15 21:09:13
+     * @param {string} methodName 更新实体方法
+     * @param {string[]} updateItems 更新项名称集合
+     */
+    updateGridEditItem(row: GridRowController, methodName: string, updateItems?: string[]): Promise<void>;
+}