@qin-ui/antd-vue-pro 2.4.4 → 2.5.0

package/src/components/table/index.ts

@@ -1,14 +1,19 @@
-import { ComponentExposed, ComponentProps } from 'vue-component-type-helpers';
+import type {
+  ComponentExposed,
+  ComponentProps,
+} from 'vue-component-type-helpers';
 import ProTable from './components/ProTable.vue';
 
-// 仅保留组件 Props 与实例类型，不将裸组件 ProTable 作为具名导出直接扔出去
+/** ProTable 的组件属性类型 */
 export type ProTableProps = ComponentProps<typeof ProTable>;
+/** ProTable 的组件实例类型，用于 `ref` 标注与 `defineExpose` 访问 */
 export type ProTableInstance = ComponentExposed<typeof ProTable>;
 
 // 仅导出核心列配置类型
-export { type Column, type Columns } from './types';
+export { type Column, type ColumnControlConfig, type Columns } from './types';
 
 // 仅导出核心表格 Hook 与类型
 export { useTable, type Table } from './hooks';
+export { type PageParam } from '../../shared/core';
 
 export default ProTable;

package/src/components/table/types/index.ts

@@ -1,8 +1,11 @@
 import type { ColumnType } from '../../../shared/ui';
-import { Data, KeyExpandString, Paths, Path } from '../../../shared/core';
+import type { Data, KeyExpandString, Paths, Path } from '../../../shared/core';
+import type { ComputedRef, MaybeRef } from 'vue';
+
+type MaybeRefOrComputedRef<T = any> = MaybeRef<T> | ComputedRef<T>;
 
 /**
- * @qin-ui/antd-vue-pro 表格列配置类型
+ * 表格列配置类型
  *
  * @description 继承 Ant Design Vue 的 ColumnType 列类型，并添加：
  * - 类型安全的 dataIndex（基于泛型 D 推导路径），优先使用
@@ -37,7 +40,7 @@ export type Column<D extends Data = Data> = Omit<
   'dataIndex' | 'key'
 > & {
   /**
-   * @description 列数据路径（主要字段）
+   * 列数据路径（主要字段）
    * 关联数据源中对应字段的路径，支持点号分隔的深层路径和数组路径。
    * 优先使用 dataIndex 进行字段匹配。
    *
@@ -45,20 +48,25 @@ export type Column<D extends Data = Data> = Omit<
    */
   dataIndex?: KeyExpandString<Extract<keyof D, string>> | Paths<D>;
   /**
-   * @description 列字段标识（辅助字段）
+   * 列字段标识（辅助字段）
    * 仅当 dataIndex 无法满足需求时使用，例如需要在自定义渲染中标识列时。
    * 在字段匹配时的优先级低于 dataIndex。
    */
   key?: Path<D>;
   /**
-   * @description 是否隐藏该列
+   * 列是否隐藏；支持布尔、Ref 与 ComputedRef 形式，渲染期按 `toValue` 取值。
+   * 分组列的子列同样参与过滤（递归生效）。
    * @default false
    */
-  hidden?: boolean;
+  hidden?: MaybeRefOrComputedRef<boolean>;
+  /**
+   * 分组子列；提供时该列作为分组表头渲染，子列沿用同一配置类型
+   */
+  children?: Column<D>[];
 };
 
 /**
- * @qin-ui/antd-vue-pro 表格列配置数组类型
+ * 表格列配置数组类型
  *
  * @template D - 表格行数据类型
  * @public

package/src/index.ts

@@ -26,7 +26,9 @@ export * from './locale';
  *   <ProForm :form="form" />
  * </template>
  * ```
- *
+ */
+export { ProForm };
+/**
  * Schema 驱动的表格组件，基于 antd-vue Table 封装
  *
  * @description 通过声明式列配置即可生成功能完整的表格，
@@ -42,7 +44,9 @@ export * from './locale';
  *   <ProTable :table="table" />
  * </template>
  * ```
- *
+ */
+export { ProTable };
+/**
  * 组件提供者，用于全局配置 ProForm 和 ProTable 的默认行为
  *
  * @description 通过 `ProComponentProvider` 包裹应用根组件，
@@ -57,10 +61,10 @@ export * from './locale';
  * </template>
  * ```
  */
-export { ProForm, ProTable, ProComponentProvider };
+export { ProComponentProvider };
 export default {
   /**
-   * @qin-ui/antd-vue-pro 安装方法
+   * 安装方法
    * @description 全局注册所有组件（ProForm、ProTable、ProComponentProvider）
    *
    * @param {App} app - Vue 应用实例
@@ -76,6 +80,9 @@ export default {
   install(app: App) {
     app.component(ProForm.name, ProForm);
     app.component(ProTable.name, ProTable);
-    app.component(ProComponentProvider.name!, ProComponentProvider);
+    app.component(
+      ProComponentProvider.name ?? 'ProComponentProvider',
+      ProComponentProvider
+    );
   },
 };

package/src/locale/index.ts

@@ -23,8 +23,10 @@ import {
 } from '../shared/core';
 import { useConfigContextInject } from '../shared/ui';
 
+/** 内置语言包：简体中文 / 繁体中文 / 英文 */
 export { zhCN, zhTW, enUS };
 
+/** 文案表类型：键为内置文案 key，值为任意字符串 */
 export type { ProLocale };
 
 /** ProComponentProvider 通过该 key 注入局部覆盖文案 */

package/src/shared/core/index.ts

@@ -2,19 +2,28 @@
  * 统一 re-export @qin-ui/pro-components-core，包内所有文件通过此文件引入 core 内容。
  */
 export {
+  // types
+  type AdditionalMethods,
+  localePacks,
+  normalizeColumn,
+  normalizeColumns,
   // hooks
   useForm,
   createFormProxy,
   useTable,
   useSearchFormExpand,
   useFields,
+  resolveFieldIdentity,
+  DEFAULT_FIELD_IDENTITY_KEYS,
   useFormData,
   useFormRef,
+  useReactiveAttrs,
   // injection keys
   InjectionFormKey,
   InjectionFormSlotsKey,
   // utils
   getObject,
+  omitBy,
   get,
   set,
   normalizePathKey,
@@ -22,7 +31,9 @@ export {
   camelizeProperties,
   cloneDeep,
   pick,
+  omit,
   isPlainObject,
+  isObjectItem,
   isPromise,
   // locale
   zhCN,

package/src/shared/ui/index.ts

@@ -1,4 +1,9 @@
-import type { FormProps as _FormProps } from 'ant-design-vue';
+import type {
+  FormProps as _FormProps,
+  Table,
+  TableProps as _TableProps,
+} from 'ant-design-vue';
+import type { ComponentProps } from 'vue-component-type-helpers';
 import type { Options } from 'scroll-into-view-if-needed';
 
 export {
@@ -36,7 +41,6 @@ export {
   type RowProps as GridProps,
   type ColProps as GridItemProps,
   type FormItemProps,
-  type TableProps,
   type PaginationProps,
 } from 'ant-design-vue';
 
@@ -48,13 +52,27 @@ export {
   useProviderDisabled,
 } from 'ant-design-vue/es/config-provider/DisabledContext';
 export { colProps as gridItemProps } from 'ant-design-vue/es/grid/Col';
+export { formItemProps } from 'ant-design-vue/es/form';
 export {
-  formItemProps,
   useInjectFormItemContext,
-} from 'ant-design-vue/es/form';
+  useProvideFormItemContext,
+} from 'ant-design-vue/es/form/FormItemContext';
 export { type NamePath } from 'ant-design-vue/es/form/interface';
 export { type MenuItemType } from 'ant-design-vue/es/menu/src/interface';
 
+/** 宿主 Form 属性面；`scrollToFirstError` 放宽为布尔或滚动配置对象 */
 export type FormProps = Omit<_FormProps, 'scrollToFirstError'> & {
   scrollToFirstError?: boolean | Options<any>;
 };
+
+/**
+ * 表格完整属性面
+ *
+ * @description 由宿主 `TableProps` 与其未声明的 emit 型属性键组成；
+ * ant-design-vue 的 Table 未暴露 `scroll` 事件面，故不提供 `@scroll` 入口。
+ */
+export interface TableProps extends _TableProps {
+  'onUpdate:expandedRowKeys'?: ComponentProps<
+    typeof Table
+  >['onUpdate:expandedRowKeys'];
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "jsx": "preserve",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "lib": ["ESNext", "ES2022", "DOM"],
+    "baseUrl": ".",
+    "declaration": true,
+    "declarationMap": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true
+  },
+  "include": ["src", "__tests__"],
+  "exclude": ["node_modules", "es"]
+}