@dazhicheng/ui 1.5.266 → 1.6.1

package/dist/components/tt-table/src/hooks/useTableMethods.js

@@ -0,0 +1,183 @@
+import { unref as t, nextTick as c } from "vue";
+import { withTreeExpand as x } from "./useTableData.js";
+function h(r, l, w, {
+  clearSelectedRowKeys: d,
+  getTableInstance: C,
+  runDataOperation: s,
+  isActive: n,
+  prepareRows: m
+}) {
+  const v = () => {
+    var e;
+    return (e = t(r).treeConfig) == null ? void 0 : e.reserve;
+  };
+  function R(e, o) {
+    return m(e), s(o);
+  }
+  return {
+    /**
+     * 从第一行插入临时数据
+     * @param records 新数据
+     */
+    insert: (e) => s(() => t(l).insert(e)),
+    /**
+     * 在指定行插入临时数据
+     * @param records 新数据
+     * @param row 指定行，-1 表示插入到底部
+     */
+    insertAt: (e, o) => s(() => t(l).insertAt(e, o)),
+    /** 在指定行之后插入临时数据 */
+    insertNextAt: (e, o) => s(() => t(l).insertNextAt(e, o)),
+    /** 在树节点下插入临时子数据 */
+    insertChild: (e, o) => s(() => t(l).insertChild(e, o)),
+    /** 在树节点下的指定位置插入临时子数据 */
+    insertChildAt: (e, o, a) => s(() => t(l).insertChildAt(e, o, a)),
+    /** 在树节点下的指定行之后插入临时子数据 */
+    insertChildNextAt: (e, o, a) => s(() => t(l).insertChildNextAt(e, o, a)),
+    /**
+     * 删除指定行
+     * @param rows 指定行
+     */
+    remove: (e) => s(() => t(l).remove(e)),
+    /** 删除复选框选中的行 */
+    removeCheckboxRow: () => s(async () => {
+      const e = await t(l).removeCheckboxRow();
+      return d(), e;
+    }),
+    /** 删除单选框选中的行 */
+    removeRadioRow: () => s(async () => {
+      const e = await t(l).removeRadioRow();
+      return d(), e;
+    }),
+    /** 删除当前行 */
+    removeCurrentRow: () => s(() => t(l).removeCurrentRow()),
+    /** 删除所有新增的临时数据 */
+    removeInsertRow: () => s(() => t(l).removeInsertRow()),
+    /** 清除表格的全部数据状态。该操作不改变业务行数据，无需触发 v-model 回写。 */
+    clearAll: async () => {
+      const e = await t(l).clearAll();
+      return d(), e;
+    },
+    /**
+     * 重新加载 VXE 当前同步数据，兼容旧的 syncData 入口。
+     * @deprecated VXE 已废弃 syncData，请使用 reloadData 或 getDataSource。
+     */
+    syncData: () => s(() => t(l).updateData()),
+    /** 重新计算 VXE 的排序、筛选数据视图。该操作不改变业务行数据。 */
+    updateData: () => t(l).updateData(),
+    /** 修改指定行数据 */
+    setRow: (e, o) => s(() => t(l).setRow(e, o)),
+    /**
+     * 退出编辑并还原行数据
+     * @param row 指定行
+     */
+    clearEditRevertData: (e) => s(async () => {
+      var o, a;
+      await ((o = t(l)) == null ? void 0 : o.clearEdit()), await ((a = t(l)) == null ? void 0 : a.revertData(e));
+    }),
+    /**
+     * 指定行激活编辑
+     * @param row 指定行
+     * @param fieldOrColumn 指定列
+     */
+    setEditRow: async (e, o) => {
+      var a;
+      await ((a = t(l)) == null ? void 0 : a.setEditRow(e, o));
+    },
+    /**
+     * 指定单元格激活编辑
+     * @param row 指定行
+     * @param fieldOrColumn 指定列
+     */
+    setEditCell: async (e, o) => {
+      var a;
+      await ((a = t(l)) == null ? void 0 : a.setEditCell(e, o));
+    },
+    /**
+     * 加载数据
+     * @param rows 数据
+     */
+    loadData: (e) => R(
+      e,
+      () => x(t(l), v(), () => t(l).loadData(e), n)
+    ),
+    /**
+     * 加载数据并恢复到初始状态
+     * @param rows 数据
+     */
+    reloadData: (e) => R(
+      e,
+      () => x(t(l), v(), () => t(l).reloadData(e), n)
+    ),
+    /**
+     * 重新加载列
+     * @param columns 列配置
+     */
+    reloadColumn: async (e) => {
+      const o = t(l).getTreeExpandRecords();
+      w.setTableColumns(e), await c(), await c();
+      const a = t(l);
+      return a && n() && v() && o.length && await a.setTreeExpand(o, !0), w.getTableColumns();
+    },
+    /**
+     * 局部加载行数据并恢复到初始状态
+     * @param rows 行
+     * @param record 新数据
+     * @param field 指定字段名
+     */
+    reloadRow: (e, o, a) => s(() => t(l).reloadRow(e, o, a)),
+    /** 还原 keep-source 保存的行数据 */
+    revertData: (e, o) => s(() => t(l).revertData(e, o)),
+    /** 加载树节点的子数据 */
+    loadTreeChildren: (e, o) => (m(o), C().loadTreeChildren(e, o)),
+    /**
+     * 清空单元格内容
+     * @param rows 指定行，为空表示整个表格
+     * @param field 指定字段名
+     */
+    clearData: (e, o) => s(() => t(l).clearData(e, o)),
+    /** 移动行到指定行位置 */
+    moveRowTo: (e, o, a) => s(() => t(l).moveRowTo(e, o, a)),
+    /** 撤销最近一次数据操作 */
+    undo: () => s(() => t(l).undo(), "visible"),
+    /** 重做最近一次数据操作 */
+    redo: () => s(() => t(l).redo(), "visible"),
+    /**
+     * 重新懒加载展开行并展开内容
+     * @param rows 指定行
+     */
+    reloadRowExpand: (e) => t(l).reloadRowExpand(e),
+    /**
+     * 重新懒加载树节点并展开该节点
+     * @param rows 指定行
+     */
+    reloadTreeExpand: (e) => s(() => t(l).reloadTreeExpand(e)),
+    /**
+     * 设置空数据提示文字
+     * @param text 提示文字
+     */
+    setEmptyText: (e) => w.setState({ emptyText: e }),
+    /**
+     * 校验表格编辑数据。
+     *
+     * 只是 vxe 校验能力的门面，不加组件自己的校验逻辑，也不改动校验提示的渲染。
+     * 两个分支都传 `true`（校验当前表格全部数据）：不传时 vxe 只校验临时变动过的行，
+     * 而这个方法的用途是提交前的整表校验。
+     * @param isFull `true` 走 vxe 的 fullValidate，逐行校验并收集所有错误；
+     *               缺省或 `false` 走 validate，遇到第一个不通过的记录即停止
+     * @returns 全部通过时为 `undefined`；否则为 vxe 原生形状 —— 以列字段为键，
+     *          值是该字段上每条违规的 `{ rules, row, rowIndex, column, columnIndex, field }`
+     */
+    validate: (e = !1) => e ? t(l).fullValidate(!0) : t(l).validate(!0),
+    /**
+     * 校验指定行的指定字段。
+     * @param row 行数据
+     * @param field 列字段名
+     * @returns 通过时为 `undefined`，否则为以列字段为键的错误映射
+     */
+    validateField: (e, o) => t(l).validateField(e, o)
+  };
+}
+export {
+  h as useTableMethods
+};

package/dist/components/tt-table/src/hooks/useTableRender.d.ts

@@ -1,12 +1,46 @@
-import { DefineSetupFnComponent } from 'vue';
-import { TtTableExtendedTableApi, TtTableProps } from '../types/table';
+import { DefineSetupFnComponent, SlotsType } from 'vue';
+import { TtTableExtendedTableApi, TtTableProps, TtTableRenderProps, TtTableSlots } from '../types/table';
 import { TtTableExtendedTableFormApi, TtTableFormProps } from '../types/tableForm';
-export type TtUseTableFormRenderReturnType = [DefineSetupFnComponent<TtTableFormProps>, TtTableExtendedTableFormApi];
+/**
+ * 表格渲染组件的事件声明。
+ *
+ * 不能写成 `Record<string, any>`：Vue 的 `EmitsToProps` 走对象分支时会算
+ * `T[K] extends (...args: infer P) => any ? P : ...`，而 `T[K]` 为 `any` 时 `P` 被推断成
+ * `unknown[]`，生成的 `on${Capitalize<string>}` 索引签名参数变成 `unknown[]`。
+ * 该类型处于参数逆变位置，会让业务侧任何具名参数的回调（`@selection-change="({ rows }) => ..."`）
+ * 都无法赋值。值声明为宽松函数签名后，`P` 推断为 `any[]`，与任意回调双向兼容。
+ */
+type TtTableRenderEmits = Record<string, (...args: any[]) => any>;
+/**
+ * useTableFormRender 的返回值
+ *
+ * `Row` 是业务行数据类型，传入后表格插槽作用域与 `tableFormApi.tableApi` 的方法签名跟着推断。
+ */
+export type TtUseTableFormRenderReturnType<Row = any> = [
+    DefineSetupFnComponent<TtTableFormProps<Row>, TtTableRenderEmits, SlotsType<TtTableSlots<Row>>>,
+    TtTableExtendedTableFormApi<Row>
+];
+/**
+ * useTableRender 的返回值
+ *
+ * `Row` 是业务行数据类型，传入后组件的 `modelValue`、插槽作用域与 `tableApi` 的方法签名跟着推断。
+ */
+export type TtUseTableRenderReturnType<Row = any> = [
+    DefineSetupFnComponent<TtTableRenderProps<Row>, TtTableRenderEmits, SlotsType<TtTableSlots<Row>>>,
+    TtTableExtendedTableApi<Row>
+];
 /**
  * 用于渲染表单和表格的 hooks。
  *
  * 返回 [FormTable 组件, TableFormApi API]。
  *
+ * `options` 用 `NoInfer` 包裹，`Row` 不再从传入的配置反向推断。业务常见写法是在
+ * `form.schemas` 的回调里引用解构出来的 api：
+ * `const [FormTable, api] = useTableFormRender({ form: { schemas: [{ onChange: () => f(api) }] } })`，
+ * 若 `Row` 从 `options` 推断，则 api 的类型依赖 options、options 又引用 api，TS 判定为循环，
+ * 整个变量退化成隐式 any 并报 TS7022/TS7023。代价是需要显式写
+ * `useTableFormRender<Row>({ ... })` 才能拿到行类型推断，不写则为 `any`。
+ *
  * @param options 表格渲染配置项
  * @returns [FormTable组件, TableFormApi API]
  *
@@ -19,13 +53,25 @@ export type TtUseTableFormRenderReturnType = [DefineSetupFnComponent<TtTableForm
  *   ...配置
  * })
  *
+ * // 需要行类型推断时显式传入
+ * const [FormTable, tableApi] = useTableFormRender<OrderRow>({
+ *   ...配置
+ * })
+ *
  * // 在模板中使用
  * <FormTable />
  */
-export declare function useTableFormRender(options: TtTableFormProps): TtUseTableFormRenderReturnType;
+export declare function useTableFormRender<Row = any>(options: NoInfer<TtTableFormProps<Row>>): TtUseTableFormRenderReturnType<Row>;
 /**
  * 用于渲染表格的 hooks，返回 [TableRender 组件, 表格API]。
  *
+ * options 只接受表格配置；单向数据使用 data，双向数据绑定到返回的 TableRender 组件。
+ *
+ * `options` 用 `NoInfer` 包裹，`Row` 不从配置反向推断。业务常见写法是初始化时给 `data: []`，
+ * 若 `Row` 从空数组推断会退化成 `never`，组件的 `data` prop 类型变成 `MaybeRef<never[]>`，
+ * 之后传入任何具体行类型都会报 TS2322。代价是需要显式写 `useTableRender<Row>({ ... })`
+ * 才能拿到行类型推断，不写则为 `any`。
+ *
  * @param options 表格渲染配置项
  * @returns [TableRender组件, 表格API]
  *
@@ -37,57 +83,13 @@ export declare function useTableFormRender(options: TtTableFormProps): TtUseTabl
  *   ...其它配置
  * })
  *
+ * // 需要行类型推断时显式传入
+ * const [TableRender, tableApi] = useTableRender<OrderRow>({
+ *   columns: [...],
+ * })
+ *
  * // 在模板中使用
  * <TableRender />
  */
-export declare function useTableRender(options: TtTableProps): readonly [DefineSetupFnComponent<TtTableProps, {}, {}, {
-    title?: string;
-    showTitle?: boolean;
-    autoHeight?: boolean;
-    offsetHeight?: number;
-    loading?: boolean;
-    loadingText?: string;
-    emptyText?: string;
-    noSearchText?: string;
-    emptyImageStyle?: import('vue').CSSProperties;
-    emptyImageStatus?: "no-data" | "no-search";
-    isHanderSubmit?: boolean;
-    modelValue?: Array<Recordable>;
-    formApi?: Partial<import('../../../tt-form').TtExtendedFormApi>;
-    columnsKey?: string | (() => string);
-    showSetting?: boolean;
-    showSetColumn?: boolean;
-    leftSlotWidth?: number;
-    rightSlotWidth?: number;
-    showLineHeight?: boolean;
-    showRefresh?: boolean;
-    useHttpCache?: boolean;
-    defaultDisplayFields?: string[];
-    getColumnsApi?: (params: {
-        permissionOnlyCode: string;
-        userId: string | number;
-    }) => Promise<{
-        data: any;
-    }>;
-    setColumnsApi?: (params: {
-        permissionOnlyCode: string;
-        json: string;
-        userId: string | number;
-    }) => Promise<any>;
-    updateColumnsApi?: (params: {
-        permissionOnlyCode: string;
-        json: string;
-        userId: string | number;
-        id: string | number;
-    }) => Promise<any>;
-    getSyncSlotComponent?: (column: any, row: any, type: "default" | "edit") => import('vue').VNode | import('vue').VNode[] | string;
-    customizeColumn?: (column: import("vxe-table").VxeTableDefines.ColumnOptions) => import("vxe-table").VxeTableDefines.ColumnOptions;
-    clearTreeExpand?: boolean;
-    isI18n?: boolean;
-    isDataCloneDeep?: boolean;
-    useSearchForm?: boolean;
-    data?: import('vue').MaybeRef<any[]>;
-    columns?: import('vue').MaybeRef<import("vxe-table").VxeTableDefines.ColumnOptions[]>;
-    testId?: string;
-    toolTipErrorPlacement?: "top" | "bottom" | "left" | "right";
-} & Omit<import('vxe-table').VxeGridProps<any>, "data" | "columns"> & import('../..').TtTablePagerProps & import('../..').TtTableColumnsProps & import('../..').TtTableFetchProps & import('../..').TtTableToolbarProps & {}, import('vue').PublicProps>, TtTableExtendedTableApi];
+export declare function useTableRender<Row = any>(options: NoInfer<TtTableProps<Row>>): TtUseTableRenderReturnType<Row>;
+export {};