@qin-ui/antd-vue-pro 2.1.3 → 2.1.5

package/es/form/index.js

@@ -111,7 +111,7 @@ const _sfc_main$4 = /* @__PURE__ */ defineComponent({
       const componentProps = { slots: {} };
       const formItemSlots = {};
       if (isPlainObject(props.field)) {
-        const { path, name, fields, formItemClass, formItemStyle, hidden, span, getFormItemRef, getComponentRef, getFormItemComputedProps, getComponentComputedProps, slots = {}, formItemDataAttrs = {}, componentDataAttrs = {}, ...rest } = props.field;
+        const { path, name, fields, formItemClass, formItemStyle, hidden, span, getFormItemRef, getComponentRef, getFormItemComputedProps, getComponentComputedProps, slots = {}, formItemDataAttrs = {}, componentDataAttrs = {}, extraProps, ...rest } = props.field;
         const {
           class: injectClassName,
           style: injectStyle,

package/es/index.d.ts

@@ -93,6 +93,30 @@ declare type __VLS_WithTemplateSlots<T, S> = T & {
     };
 };
 
+declare type AdditionalMethods<FormItemInstance> = {
+    /**
+     * @description 获取FormItem实例的方法
+     */
+    getFormItemRef?: () => FormItemInstance;
+    /**
+     * @description 获取传入FormItem组件的属性
+     */
+    getFormItemComputedProps?: () => Readonly<{
+        [x: string]: any;
+    }>;
+    /**
+     * @description 获取组件实例的方法
+     */
+    getComponentRef?: () => any;
+    /**
+     * @description 获取传入Component组件的属性
+     */
+    getComponentComputedProps?: () => Readonly<{
+        disabled?: boolean;
+        [x: string]: any;
+    }>;
+};
+
 declare type AllowStringKey<T, Prefix extends string = ''> = {
     [K in keyof T]: K extends string ? T[K] extends (infer U)[] ? `${Prefix}${K}` | (IsRecord<U> extends true ? AllowStringKey<U, `${Prefix}${K}[index].`> : never) : IsRecord<T[K]> extends true ? `${Prefix}${K}` | AllowStringKey<T[K], `${Prefix}${K}.`> : `${Prefix}${K}` : never;
 }[keyof T];
@@ -186,6 +210,11 @@ export declare interface Base<D extends Data = Data> {
      * @example { 'data-test': 'input-value', 'aria-label': 'name' }
      */
     componentDataAttrs?: Record<string, string>;
+    /**
+     * @description 额外的自定义属性，不会被当作组件参数，仅用做给字段添加标识属性等功能
+     * @example { group: 'group-1' }
+     */
+    extraProps?: Record<string, any>;
 }
 
 declare interface BaseColumn<D extends Data = Data> {
@@ -289,7 +318,7 @@ export declare interface ComponentMap {
 
 export declare const componentMap: BaseComponentMap;
 
-export declare type ComponentName = keyof BaseComponentMap | keyof ComponentMap;
+export declare type ComponentName = keyof BaseComponentMap | keyof ComponentMap | 'custom';
 
 export declare type ComponentVars = Partial<RequiredComponentVars>;
 
@@ -420,11 +449,7 @@ declare type ExtendWithAny<D> = {
  * @description 字段配置类型，包含所有字段属性和响应式支持
  * @template D - 数据对象类型
  */
-export declare type Field<D extends Data = Data> = WithAdditionalMethodsGetter<{
-    [K in keyof FieldTypeMap]: {
-        component?: K extends 'custom' ? FieldTypeMap<D>[K]['component'] : K;
-    } & FieldTypeMap<D>[K];
-}[keyof FieldTypeMap]>;
+export declare type Field<C extends ComponentName = ComponentName, D extends Data = Data> = FieldTypeMap<D>[C];
 
 declare type FieldFindBy<D extends Data, F extends BaseField_2<D> = BaseField_2<D>> = (field: Readonly<F>) => boolean;
 
@@ -432,29 +457,29 @@ declare type FieldFindBy<D extends Data, F extends BaseField_2<D> = BaseField_2<
  * @description 字段数组类型
  * @template D - 数据对象类型
  */
-export declare type Fields<D extends Data = Data> = Array<Field<D>>;
+export declare type Fields<D extends Data = Data> = Array<Field<ComponentName, D>>;
 
 /**
  * @type {FieldTypeMap} 字段类型集合
  */
 export declare type FieldTypeMap<D extends Data = Data> = {
-    /** 自定义组件 */
-    custom: {
-        component?: RenderComponentType | Raw<RenderComponentType>;
-    } & WithCommon<{
+    [K in ComponentName]: K extends 'custom' ? WithCommon<{
         slots?: Slots;
-    } & Record<string, any>, D>;
-} & {
-    [K in ComponentName]: WithComponent<GetComponentType<K>, D>;
+        [x: string]: any;
+    }, D> & {
+        component?: RenderComponentType | Raw<RenderComponentType>;
+    } : WithComponent<GetComponentType<K>, D> & {
+        component?: K;
+    };
 };
 
 /**
  * 重新定义 Form 类型：
- * 1. 将第二个泛型参数 F 默认绑定为本地 Field<D>；
+ * 1. 将第二个泛型参数 F 默认绑定为本地 Field<ComponentName, D>；
  * 2. 将 core Form 的第三个泛型参数 I 绑定为本地 UI 库（Ant Design Vue）的 FormInstance，
  *    使 formRef 的类型变为 Ref<FormInstance | undefined>。
  */
-export declare type Form<D extends Data = Data, F extends Field<D> = Field<D>> = Form_2<D, F, FormInstance>;
+export declare type Form<D extends Data = Data, F extends Field<ComponentName, D> = Field<ComponentName, D>> = Form_2<D, F, FormInstance>;
 
 declare type Form_2<D extends Data = Data, F extends BaseField_2<D> = BaseField_2<D>, I = any> = ReturnType<typeof useFormData<D>> & ReturnType<typeof useFields_2<D, F>> & ReturnType<typeof useFormRef_2<I>>;
 
@@ -736,8 +761,6 @@ export declare type ProTableInstance = ComponentExposed<typeof _default_2>;
 
 export declare type ProTableProps = ComponentProps<typeof _default_2>;
 
-declare type ReadonlyFormItemProps = ComponentProps<typeof FormItem>;
-
 /**
  * @description 自定义组件
  * @example (p, ctx) => h('div', ctx.attrs)
@@ -756,7 +779,7 @@ export declare type RequiredComponentVars = {
     'date-picker.year': FP<ComponentProps<GetComponentType<'date-picker'>>>;
     'date-picker.quarter': FP<ComponentProps<GetComponentType<'date-picker'>>>;
 } & {
-    [K in ComponentName]: FP<ComponentProps<GetComponentType<K>>>;
+    [K in Exclude<ComponentName, 'custom'>]: FP<ComponentProps<GetComponentType<K>>>;
 };
 
 declare type SearchFormProps = {
@@ -823,23 +846,23 @@ export declare type UseFields<D extends Data = Data> = ReturnType<typeof useFiel
 
 /**
  * 类型断言 re-export @qin-ui/core 的 useFields，
- * 将泛型参数 F 的默认值覆盖为本地的 Field<D>，
+ * 将泛型参数 F 的默认值覆盖为本地的 Field<ComponentName, D>，
  * 使得 fields、getField 等方法的类型推断包含 Ant Design Vue 的完整属性签名。
  */
 export declare const useFields: {
-    <D extends Data = Data>(initFields?: Fields<D>): ReturnType<typeof useFields_2<D, Field<D>>>;
+    <D extends Data = Data>(initFields?: Fields<D>): ReturnType<typeof useFields_2<D, Field<ComponentName, D>, FormItemInstance>>;
 };
 
-declare const useFields_2: <D extends Data = Data, F extends BaseField_2<D> = BaseField_2<D>>(initFields?: F[]) => {
+declare const useFields_2: <D extends Data = Data, F extends BaseField_2<D> = BaseField_2<D>, FormInstance = any>(initFields?: F[]) => {
     fields: Ref<F[], F[]>;
     getField: {
-        (path: Path<D> | FieldFindBy<D, F>): Readonly<F> | undefined;
+        (path: Path<D> | FieldFindBy<D, F>): Readonly<F & AdditionalMethods<FormInstance>> | undefined;
         (path: Path<D> | FieldFindBy<D, F>, options?: {
             all?: false;
-        }): Readonly<F> | undefined;
+        }): Readonly<F & AdditionalMethods<FormInstance>> | undefined;
         (path: Path<D> | FieldFindBy<D, F>, options: {
             all: true;
-        }): Readonly<F>[] | undefined;
+        }): Readonly<F & AdditionalMethods<FormInstance>>[] | undefined;
     };
     setField: (path: Path<D> | FieldFindBy<D, F>, field: F | ((preField: Readonly<F>) => F), options?: {
         updateType?: "rewrite" | "merge";
@@ -848,23 +871,23 @@ declare const useFields_2: <D extends Data = Data, F extends BaseField_2<D> = Ba
     appendField: (path: Path<D> | FieldFindBy<D, F> | undefined, field: F | F[], options?: UpdateFieldOptions) => void;
     prependField: (path: Path<D> | FieldFindBy<D, F> | undefined, field: F | F[], options?: UpdateFieldOptions) => void;
     getParentField: {
-        (path: Path<D> | FieldFindBy<D, F>): F | undefined;
+        (path: Path<D> | FieldFindBy<D, F>): Readonly<F & AdditionalMethods<FormInstance>> | undefined;
         (path: Path<D> | FieldFindBy<D, F>, options: {
             all?: false;
-        }): F | undefined;
+        }): Readonly<F & AdditionalMethods<FormInstance>> | undefined;
         (path: Path<D> | FieldFindBy<D, F>, options: {
             all: true;
-        }): F[] | undefined;
+        }): Readonly<F & AdditionalMethods<FormInstance>>[] | undefined;
     };
 };
 
 /**
  * 类型断言 re-export @qin-ui/core 的 useForm，
- * 将默认返回的 Form<D, BaseField<D>> 覆盖为本地的 Form<D, Field<D>>。
+ * 将默认返回的 Form<D, BaseField<D>> 覆盖为本地的 Form<D, Field<ComponentName, D>>。
  */
 export declare const useForm: {
-    <D extends Data = Data>(initFormData?: ExtendWithAny<DeepPartial<D>>, initFields?: Field<D>[], root?: boolean): Form<D, Field<D>>;
-    <D extends Data = Data>(root?: boolean): Form<D, Field<D>>;
+    <D extends Data = Data>(initFormData?: ExtendWithAny<DeepPartial<D>>, initFields?: Field<ComponentName, D>[], root?: boolean): Form<D, Field<ComponentName, D>>;
+    <D extends Data = Data>(root?: boolean): Form<D, Field<ComponentName, D>>;
 };
 
 /**
@@ -925,31 +948,7 @@ export declare type VModelProps<T = any> = {
     'onUpdate:value'?: (val: T) => void;
 };
 
-export declare type WithAdditionalMethodsGetter<T> = T & {
-    /**
-     * @description 获取FormItem实例的方法
-     */
-    getFormItemRef?: () => FormItemInstance;
-    /**
-     * @description 获取传入FormItem组件的属性
-     */
-    getFormItemComputedProps?: () => Readonly<{
-        [x: string]: any;
-    }>;
-    /**
-     * @description 获取组件实例的方法
-     */
-    getComponentRef?: () => any;
-    /**
-     * @description 获取传入Component组件的属性
-     */
-    getComponentComputedProps?: () => Readonly<{
-        disabled?: boolean;
-        [x: string]: any;
-    }>;
-};
-
-declare type WithCommon<T, D extends Data = Data> = WithRef<T & Omit<ReadonlyFormItemProps, 'label'> & ColProps & Base<D>>;
+declare type WithCommon<T, D extends Data = Data> = WithRef<T & Omit<FormItemProps, 'label'> & ColProps & Base<D>>;
 
 /**
  * @description 自动从 Vue 组件提取 Props 和 Slots，并加上公共表单字段属性
@@ -958,7 +957,7 @@ declare type WithCommon<T, D extends Data = Data> = WithRef<T & Omit<ReadonlyFor
  */
 declare type WithComponent<T extends abstract new (...args: any) => any, D extends Data = Data> = WithCommon<{
     slots?: ComponentSlots<T>;
-} & ComponentProps<T>, D>;
+} & Omit<ComponentProps<T>, keyof VNodeProps>, D>;
 
 /**
  * @description 为对象属性添加响应式支持的类型

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qin-ui/antd-vue-pro",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "二次封装antd vue组件",
   "type": "module",
   "module": "es/index.js",