xph-crud 0.3.1 → 0.3.2

package/dist/types/common/index.d.ts

@@ -1,4 +1,4 @@
 export * from './src/utils';
-export * from './src/componnets';
+export * from './src/components';
 export * from './src/hooks';
 export * from './src/types';

package/dist/types/common/src/{componnets → components}/actions/types/actionItem.d.ts

@@ -2,11 +2,17 @@ import { ButtonProps, MenuProps } from 'antd';
 import { TXphExtendComponentPropsMap } from '../../../types';
 
 export interface IBaseActionProps {
-    /** 唯一标识 */
+    /**
+     * @description 唯一标识
+     */
     key?: string;
-    /** 是否显示 */
+    /**
+     * @description 是否显示
+     */
     ifShow?: boolean | (() => any);
-    /** 权限标识 */
+    /**
+     * @description 权限标识
+     */
     auth?: string | Array<string>;
 }
 export type TComponentType<T extends TXphExtendComponentPropsMap = {}> = {
@@ -17,40 +23,64 @@ interface IButtonProps extends ButtonProps {
 }
 interface IDropdownProps extends Omit<ButtonProps, "onClick"> {
     dropDownItems: {
+        /**
+         * @description 唯一标识
+         */
         key: string;
+        /**
+         * @description 显示文本
+         */
         label: string;
-        /** 注意：父级如果disabled为true，子级无法展开（所以相当于是变向的父级禁用，子级也禁用了） */
+        /**
+         * @description 是否禁用，注意：父级如果disabled为true，子级无法展开（所以相当于是变向的父级禁用，子级也禁用了）
+         */
         disabled?: boolean;
+        /**
+         * @description 图标
+         */
         icon?: React.ReactNode;
-        /** 是否显示 */
+        /**
+         * @description 是否显示
+         */
         ifShow?: boolean | (() => any);
-        /** 权限标识 */
+        /**
+         * @description 权限标识
+         */
         auth?: string | Array<string>;
     }[];
     onClick?: MenuProps["onClick"];
 }
-/** 组件类型 */
+/**
+ * @description 组件类型action
+ */
 export interface IComponentActionProps<T extends keyof TComponentType<K>, K extends TXphExtendComponentPropsMap = {}> extends IBaseActionProps {
-    /** 组件 */
+    /**
+     * @description 组件
+     */
     component: T;
-    /** 组件属性 */
+    /**
+     * @description 组件属性
+     */
     componentProps?: TComponentType<K>[T];
 }
-/** 自定义内容 */
+/**
+ * @description 自定义内容action
+ */
 export interface IRenderActionProps extends IBaseActionProps {
-    /** 自定义内容 */
+    /**
+     * @description 自定义内容函数
+     */
     render: React.ReactElement;
 }
 /**
- *
- * 这个类型接受两个泛型参数 T 和 K。它使用了 TypeScript 中的映射类型，并从 T 中移除 K 对应的属性。这样做的结果是，返回的类型会继承 T，但移除了 K 对应的属性
+ * @description 这个类型接受两个泛型参数 T 和 K。它使用了 TypeScript 中的映射类型，并从 T 中移除 K 对应的属性。这样做的结果是，返回的类型会继承 T，但移除了 K 对应的属性
  */
 type Without<T, K> = {
     [P in Exclude<keyof T, K>]?: never;
 };
 /**
- *
- * 这个 `XOR` 类型的定义是一个 TypeScript 中的条件类型，用于实现对多个类型的互斥组合。现在，我会逐步解释这个类型的定义：
+ * @description
+这个 `XOR` 类型的定义是一个 TypeScript 中的条件类型，用于实现对多个类型的互斥组合。现在，我会逐步解释这个类型的定义：
 
 1. `T extends [infer A, infer B, ...infer Rest]`：这个条件判断首先检查泛型类型 `T` 是否是一个元组类型。如果是的话，它会将元组的第一个类型赋值给 `A`，第二个类型赋值给 `B`，并将剩余的类型赋值给 `Rest`。如果 `T` 不是元组类型，则跳到下一个条件。
 
@@ -62,17 +92,28 @@ type Without<T, K> = {
 
 5. `: never`：如果 `T` 不是一个元组，并且不止一个元素，则返回 `never` 类型，表示无法匹配任何类型。
 
-综上所述，这个 `XOR` 类型的定义通过条件类型实现了对多个类型的互斥组合，并确保在同一时间只能使用其中一个类型。
+综上所述，这个 `XOR` 类型的定义通过条件类型实现了对多个类型的互斥组合，并确保在同一时间只能使用其中一个类型
  */
 type XOR<T extends any[]> = T extends [infer A, infer B, ...infer Rest] ? A | B extends object ? (Without<A, keyof B> & B) | (Without<B, keyof A> & A) | XOR<[A | B, ...Rest]> : A | B : T extends [infer A] ? A : never;
+/**
+ * @description 将组件类型映射为 IComponentActionProps
+ */
 type TMapComponentActionProps<T extends TXphExtendComponentPropsMap> = {
     [K in keyof TComponentType<T>]: IComponentActionProps<K, T>;
 }[keyof TComponentType<T>];
+/**
+ * @description 合并 IComponentActionProps 和 IRenderActionProps
+ */
 export type TActionItemProps<T extends TXphExtendComponentPropsMap = {}> = XOR<[
     TMapComponentActionProps<T>,
     IRenderActionProps
 ]>;
-/** 判断是哪种类型的action */
+/**
+ * @description 判断是否为组件类型action
+ */
 export declare function isComponentActionItemProps(item: TActionItemProps): item is IComponentActionProps<"Button">;
+/**
+ * @description 判断是否为自定义内容action
+ */
 export declare function isRenderActionItemProps(item: TActionItemProps): item is IRenderActionProps;
 export {};

package/dist/types/common/src/components/actions/types/actions.d.ts

@@ -0,0 +1,30 @@
+import { TActionItemProps } from './actionItem';
+import { ButtonProps } from 'antd/lib/button';
+import { TXphExtendComponentPropsMap } from '../../../types';
+
+export interface IActionsProps<T extends TXphExtendComponentPropsMap = {}> {
+    /**
+     * @description 类型
+     */
+    type?: ButtonProps["type"];
+    /**
+     * @description 操作项
+     */
+    items?: TActionItemProps<T>[];
+    /**
+     * @description 禁用（items中的componentProps的disabled优先级最高）
+     */
+    disabled?: boolean;
+    /**
+     * @description 自定义内容（items的优先级高于render）
+     */
+    render?: React.ReactElement;
+    /**
+     * @description 超过多少个item自动省略，默认是10（其余全部放在一个dropdown中）
+     */
+    max?: number;
+    /**
+     * @description 是否需要从扩展中继承属性（可能有些特殊情况，不需要使用扩展中的属性）
+     */
+    inherit?: boolean;
+}

package/dist/types/common/src/{componnets → components}/dialog/hooks/useDialogContentMaxHeight.d.ts

@@ -1,4 +1,4 @@
-import { IContainerSizeTarget } from '../hooks';
+import { IContainerSizeTarget } from '.';
 
 declare const useDialogContentMaxHeight: ({ visible, containerSizeTarget, dialogHeight, dialogRef, dialogHeaderRef, dialogFooterRef, }: {
     visible: boolean;

package/dist/types/common/src/{componnets → components}/dialog/hooks/useDialogFooter.d.ts

@@ -1,5 +1,5 @@
 import { IDialogProps } from '../types';
-import { IXphActionsProps } from '../../';
+import { IXphActionsProps } from '../..';
 
 export default function useDialogFooter(props: IDialogProps, loading: boolean): {
     footerActions: IXphActionsProps<{}>;

package/dist/types/common/src/{componnets → components}/dialog/hooks/useDialogPosition.d.ts

@@ -1,4 +1,4 @@
-import { IDialogChangeRecord } from '../hooks';
+import { IDialogChangeRecord } from '.';
 
 declare const useDialogPosition: ({ initLeft, initTop, setDialogChangeRecord, }: {
     initLeft: React.MutableRefObject<number>;

package/dist/types/common/src/{componnets → components}/dialog/hooks/useDialogSize.d.ts

@@ -1,4 +1,4 @@
-import { IDialogChangeRecord } from '../hooks';
+import { IDialogChangeRecord } from '.';
 
 declare const useDialogInitSize: ({ initWidth, initHeight, setDialogChangeRecord, }: {
     initWidth: React.MutableRefObject<string | number>;

package/dist/types/common/src/{componnets → components}/dialog/hooks/useDialogZoom.d.ts

@@ -1,4 +1,4 @@
-import { IDialogChangeRecord, IContainerSizeTarget } from '../hooks';
+import { IDialogChangeRecord, IContainerSizeTarget } from '.';
 
 declare const useDialogZoom: ({ containerSizeTarget, dialogChangeRecord, close, setDialogSize, setDialogPosition, }: {
     containerSizeTarget: React.MutableRefObject<IContainerSizeTarget>;

package/dist/types/common/src/{componnets → components}/dialog/hooks/useDragDialog.d.ts

@@ -1,4 +1,4 @@
-import { IContainerSizeTarget } from '../hooks';
+import { IContainerSizeTarget } from '.';
 
 declare const useDragDialog: ({ containerSizeTarget, dialogHeaderRef, dialogRef, setDialogPosition, }: {
     containerSizeTarget: React.MutableRefObject<IContainerSizeTarget>;

package/dist/types/common/src/{componnets → components}/dialog/hooks/useResizeDialog.d.ts

@@ -1,5 +1,5 @@
 import { MouseEvent } from 'react';
-import { IContainerSizeTarget } from '../hooks';
+import { IContainerSizeTarget } from '.';
 
 declare const useResizeDialog: ({ containerSizeTarget, dialogRef, minResizeRecord, setDialogSize, setDialogPosition, setMinResizeRecord, }: {
     containerSizeTarget: React.MutableRefObject<IContainerSizeTarget>;

package/dist/types/common/src/components/dialog/types/dialog.d.ts

@@ -0,0 +1,87 @@
+import { ButtonProps } from 'antd';
+
+export interface IDialogProps {
+    /**
+     * @default 700
+     * @description 弹窗的宽度
+     */
+    width?: number;
+    /**
+     * @default -
+     * @description 弹窗的高度
+     */
+    height?: number;
+    /**
+     * @default false
+     * @description 是否显示遮罩
+     */
+    mask?: boolean;
+    /**
+     * @default -
+     * @description 弹窗的标题
+     */
+    title?: string;
+    /**
+     * @default -
+     * @description 确定按钮属性
+     */
+    okProps?: Omit<ButtonProps, "children" | "onClick">;
+    /**
+     * @default -
+     * @description 取消按钮属性
+     */
+    cancelProps?: Omit<ButtonProps, "children" | "onClick">;
+    /**
+     * @default "确定"
+     * @description 确定按钮文字
+     */
+    okText?: string;
+    /**
+     * @default "取消"
+     * @description 取消按钮文字
+     */
+    cancelText?: string;
+    /**
+     * @default -
+     * @description 点击确定按钮触发该事件
+     */
+    onOk?: (args: any) => Promise<void>;
+    /**
+     * @default -
+     * @description 点击取消按钮触发该事件
+     */
+    onCancel?: (args: any) => Promise<void>;
+    /**
+     * @default -
+     * @description 底部按钮自定义渲染函数
+     */
+    renderFooter?: ({ loading }: {
+        loading: boolean;
+    }) => React.ReactElement;
+    /**
+     * @default -
+     * @description 顶部标题自定义渲染函数
+     */
+    renderTitle?: () => React.ReactElement;
+    /**
+     * @default -
+     * @description 打开的时候会触发该事件
+     */
+    onOpen?: () => void;
+    /**
+     * @default -
+     * @description 关闭的时候会触发该事件
+     */
+    onClose?: () => void;
+    /**
+     * @default () => document.body
+     * @description 挂载弹窗的容器
+     */
+    getPopperContainer?: () => HTMLElement | null;
+}
+export interface IDialogActionType {
+    open: () => Promise<void>;
+    close: () => void;
+    setLoading: (loading: boolean) => void;
+    getVisible: () => boolean;
+}

package/dist/types/common/src/hooks/useExtendCompProps.d.ts

@@ -1,5 +1,5 @@
 import { default as React } from 'react';
-import { IXphActionsProps } from '../componnets';
+import { IXphActionsProps } from '../components';
 import { IXphFormProps } from '../../../form';
 import { TXphTableProps } from '../../../table';
 import { IXphDialogProps, IXphAuthProps } from '../..';

package/dist/types/common/src/types/extendComponent.d.ts

@@ -1,2 +1,4 @@
-/** 扩展组件的props映射（共用） */
+/**
+ * @description 扩展组件的props映射（共用）
+ */
 export type TExtendComponentPropsMap = Record<string, any>;

package/dist/types/common/src/utils/getValueByPath.d.ts

@@ -1,9 +1,9 @@
 export declare const getValueByPath: (obj: Record<string, any>, path: string) => any;
 /**
  * @description 通过属性为包含.的字符串的对象从值对象中获取值
- * @param fields = { current: 'data.current', pageSize: 'data.pageSize' }
- * @param values = { data: { current: 1, pageSize: 10 } }
- * @returns = { current: 1, pageSize: 10 }
- *
+ * @example
+ * fields { current: 'data.current', pageSize: 'data.pageSize' }
+ * values { data: { current: 1, pageSize: 10 } }
+ * return { current: 1, pageSize: 10 }
  */
 export declare const getValuesByPathObj: (fields: Record<string, string>, values: Record<string, any>) => Record<string, any>;

package/dist/types/form/src/types/form.d.ts

@@ -7,42 +7,88 @@ export interface IRegister {
     (methods: IFormActionType): void;
 }
 export interface IFormProps<T extends TXphExtendComponentPropsMap = {}> {
-    items: TFormItemProps<T>[] /** 表单项配置集合 */;
     /**
-     * @description 表单布局方式（默认horizontal）
-     * @description 排除了antd的inline，因为可以使用colProps实现inline布局
+     * @default []
+     * @description 表单项配置集合
+     */
+    items: TFormItemProps<T>[];
+    /**
+     * @default "horizontal"
+     * @description 表单布局方式，排除了antd的inline，因为可以使用colProps实现inline布局
      */
     layout?: "horizontal" | "vertical";
-    /** 表示是否显示 label 后面的冒号 (只有在属性 layout 为 horizontal 时有效) */
+    /**
+     * @default false
+     * @description 表示是否显示 label 后面的冒号 (只有在属性 layout 为 horizontal 时有效)
+     */
     colon?: boolean;
-    /** 设置表单组件禁用，仅对 antd 组件有效 */
+    /**
+     * @default -
+     * @description 设置表单组件禁用，仅对 antd 组件有效
+     */
     disabled?: boolean;
-    /** 表单项组件布局方式(wrapperCol的span与labelCol的span形成24栅格布局) */
+    /**
+     * @default -
+     * @description 表单项组件布局方式(wrapperCol的span与labelCol的span形成24栅格布局)
+     */
     wrapperCol?: ColProps;
-    /** label 标签的文本换行方式 */
+    /**
+     * @default true
+     * @description label 标签的文本换行方式
+     */
     labelWrap?: boolean;
-    /** label 标签的文本对齐方式 */
+    /**
+     * @default -
+     * @description label 标签的文本对齐方式
+     */
     labelAlign?: "left" | "right";
-    /** 表单项label标签布局方式(wrapperCol的span与labelCol的span形成24栅格布局) */
+    /**
+     * @default -
+     * @description 表单项label标签布局方式(wrapperCol的span与labelCol的span形成24栅格布局)
+     */
     labelCol?: ColProps;
-    /** 表单项的栅格配置 */
+    /**
+     * @default -
+     * @description 表单项的栅格配置
+     */
     colProps?: ColProps;
-    /** 提交失败自动滚动到第一个错误字段 */
+    /**
+     * @default -
+     * @description 提交失败自动滚动到第一个错误字段
+     */
     scrollToFirstError?: boolean;
-    /** 设置字段组件的尺寸（仅限 antd 组件） */
+    /**
+     * @default -
+     * @description 设置字段组件的尺寸（仅限 antd 组件）
+     */
     size?: "large" | "middle" | "small";
-    /** 是否可折叠，默认超过5个折叠 */
+    /**
+     * @default -
+     * @description 是否可折叠，默认超过5个折叠
+     */
     collapsible?: boolean;
-    /** 超过多少进行折叠，collapsible为true才生效 */
+    /**
+     * @default 5
+     * @description 超过多少进行折叠，collapsible为true才生效
+     */
     collapseNum?: number;
-    /** 渲染操作组，用于渲染表单项的操作，这是一个预留项，是否需要操作组由业务自己决定（会跟折叠同行显示） */
+    /**
+     * @default -
+     * @description 渲染操作组，用于渲染表单项的操作，这是一个预留项，是否需要操作组由业务自己决定（会跟折叠同行显示）
+     */
     renderActions?: () => React.ReactElement;
-    /** 时间返回统一处理函数 */
+    /**
+     * @default (date: any, format: string) => { return date?.format?.(format || "YYYY-MM-DD HH:mm:ss") ?? date; }
+     * @description 时间返回统一处理函数
+     */
     transformDateFunc?: (date: any, format: string) => string;
     /**
-     * @description 用于将表单内时间区域的应设成 2 个字段,见下方说明
-     * @description 如果表单内有时间区间组件，获取到的值是一个数组，但是往往我们传递到后台需要是 2 个字段
+     * @default -
+     * @description 用于将表单内时间区域的应设成 2 个字段，见下方案例
      * @example
+     *
+     * // 场景：如果表单内有时间区间组件，获取到的值是一个数组，但是往往我们传递到后台需要是 2 个字段
+     *
      * fieldMapToTime: [
      *    // data为时间组件在表单内的字段，startTime，endTime为转化后的开始时间与结束时间
      *    // 'YYYY-MM-DD'为时间格式，参考moment
@@ -75,7 +121,10 @@ export interface IFormProps<T extends TXphExtendComponentPropsMap = {}> {
      * }
      */
     fieldMapToTime?: [string, [string, string], (string | [string, string])?][];
-    /** 注册事件（useForm使用，form组件会在挂载后调用） */
+    /**
+     * @default -
+     * @description 注册事件（useForm使用，form组件会在挂载后调用）
+     */
     register?: IRegister;
 }
 export interface IFormActionType {

package/dist/types/form/src/types/formItem.d.ts

@@ -5,45 +5,122 @@ import { ColProps } from 'antd';
 import { IFormActionType } from './form';
 import { TXphExtendComponentPropsMap } from '../../../common';
 
-/**
- * 字符串类型对象
- */
 export type Recordable<T> = Record<string, T>;
 export type TFunction<T> = T | ((args: Recordable<any>) => T);
 export interface IBaseFormItemProps {
-    name: string /** 字段名 */;
-    label: string /** 标签名 */;
-    valuePropName?: string /** 子节点的值的属性，如 Switch、Checkbox 的是 checked */;
-    show?: TFunction<boolean> /** 是否显示（相当于display:none） */;
-    ifShow?: TFunction<boolean> /** 是否显示（会新增或删除节点） */;
-    required?: TFunction<boolean> /** 是否必填 */;
-    disabled?: TFunction<boolean> /** 是否禁用（当和 Form 同时设置时，以 Item 为准） */;
-    componentProps?: TFunction<Recordable<any>> /** 组件属性 */;
-    rules?: Rule[] /** 校验规则 */;
-    wrapperCol?: ColProps /** 表单项组件的布局方式（当和 Form 同时设置时，以 Item 为准） */;
-    labelCol?: ColProps /** 表单项label标签布局方式（当和 Form 同时设置时，以 Item 为准） */;
-    colProps?: ColProps /** 表单项的栅格配置（当和 Form 同时设置时，以 Item 为准） */;
-    forceRow?: boolean /** 是否强制换一行显示该表单项（强制换行后续会跟随换行表单项） */;
-    initialValue?: any /** 默认值 */;
+    /**
+     * @default -
+     * @description 字段名
+     */
+    name: string;
+    /**
+     * @default -
+     * @description 标签名
+     */
+    label: string;
+    /**
+     * @default -
+     * @description 子节点的值的属性，如 Switch、Checkbox 的是 checked
+     */
+    valuePropName?: string;
+    /**
+     * @default -
+     * @description 是否显示（相当于display:none）
+     */
+    show?: TFunction<boolean>;
+    /**
+     * @default -
+     * @description 是否显示（会新增或删除节点）
+     */
+    ifShow?: TFunction<boolean>;
+    /**
+     * @default -
+     * @description 是否必填
+     */
+    required?: TFunction<boolean>;
+    /**
+     * @default -
+     * @description 是否禁用（当和 Form 同时设置时，以 Item 为准）
+     */
+    disabled?: TFunction<boolean>;
+    /**
+     * @default -
+     * @description 组件属性
+     */
+    componentProps?: TFunction<Recordable<any>>;
+    /**
+     * @default -
+     * @description 校验规则
+     */
+    rules?: Rule[];
+    /**
+     * @default -
+     * @description 表单项组件的布局方式（当和 Form 同时设置时，以 Item 为准）
+     */
+    wrapperCol?: ColProps;
+    /**
+     * @default -
+     * @description 表单项label标签布局方式（当和 Form 同时设置时，以 Item 为准）
+     */
+    labelCol?: ColProps;
+    /**
+     * @default -
+     * @description 表单项的栅格配置（当和 Form 同时设置时，以 Item 为准）
+     */
+    colProps?: ColProps;
+    /**
+     * @default -
+     * @description 是否强制换一行显示该表单项（强制换行后续会跟随换行表单项）
+     */
+    forceRow?: boolean;
+    /**
+     * @default -
+     * @description 默认值
+     */
+    initialValue?: any;
 }
-/** 自定义渲染函数的props */
+/**
+ * @description 自定义渲染函数的props
+ */
 export interface IFRenderProps {
+    /**
+     * @description 当前项name
+     */
     name: string;
+    /**
+     * @description 当前项状态
+     */
     disabled: boolean;
+    /**
+     * @description 组件属性
+     */
     componentProps: Recordable<any>;
+    /**
+     * @description 表单值
+     */
     model: any;
+    /**
+     * @description 表单方法实例
+     */
     methods: IFormActionType;
 }
-/** render props */
 /**
- * @description: 自定义渲染组件，若根节点为antd组件，就会和form组件进行双向绑定，model也是响应式的；若根节点为非antd组件，就不会和form组件进行双向绑定，需根据实际业务手动处理表单项的值
+ * @description render props（自定义渲染函数，若根节点为antd组件，就会和form组件进行双向绑定，model也是响应式的；若根节点为非antd组件，就不会和form组件进行双向绑定，需根据实际业务手动处理表单项的值）
  */
 export interface IRenderFormItemProps extends IBaseFormItemProps {
-    render: (props: IFRenderProps) => React.ReactNode /** 自定义渲染组件 */;
+    /**
+     * @description 自定义渲染函数
+     */
+    render: (props: IFRenderProps) => React.ReactNode;
 }
-/** component props */
+/**
+ * @description component props
+ */
 export interface IComponentFormItemProps<T extends TXphExtendComponentPropsMap = {}> extends IBaseFormItemProps {
-    component: keyof TComponentPropsMap<T> /** 映射组件 */;
+    /**
+     * @description 映射组件
+     */
+    component: keyof TComponentPropsMap<T>;
 }
 type Without<T, K> = {
     [P in Exclude<keyof T, K>]?: never;

package/dist/types/table/src/components/crudFormDialog/index.d.ts

@@ -5,11 +5,11 @@ import { TXphExtendComponentPropsMap } from '../../../../common';
 declare const CrudFormDialog: (props: TCrudFormDialogProps, ref: ForwardedRef<ICrudFormDialogActionType>) => import("react/jsx-runtime").JSX.Element;
 declare const ForwardedCrudFormDialog: <T extends TXphExtendComponentPropsMap = {}>(props: Omit<import('../../../../common').IXphDialogProps, "onOk" | "onCancel"> & {
     formProps: import('../../../../form').IXphFormProps<T>;
-    onOk?: (({ values, data }: {
+    onOk?: ((event: {
         values: any;
         data: any;
     }) => Promise<any>) | undefined;
-    onCancel?: (({ values, data }: {
+    onCancel?: ((event: {
         values: any;
         data: any;
     }) => Promise<any>) | undefined;

package/dist/types/table/src/components/table/components/cellFunc/types/cellFunc.d.ts

@@ -1,17 +1,25 @@
 import { IXphActionsProps, TXphExtendComponentPropsMap } from '../../../../../../../common';
 import { IComponentColumnProps, TDataSourceItem } from '../../../../../types';
 
-/** cellFunc中每一项对应的组件componentProps属性映射  */
+/**
+ * @description cellFunc中每一项对应的组件componentProps属性映射
+ */
 export type TCellComponentPropsMap<CellFuncExtendPropsMap extends TXphExtendComponentPropsMap = {}, ActionsExtendPropsMap extends TXphExtendComponentPropsMap = {}> = {
     link: {
-        /** 超链接，点击超链接跳转 */
+        /**
+         * @description 超链接，点击超链接跳转
+         */
         url?: string;
-        /** 点击事件（优先级最高） */
+        /**
+         * @description 点击事件（优先级最高）
+         */
         onClick?: () => void;
     };
     actions: IXphActionsProps<ActionsExtendPropsMap>;
     tag: {
-        /** 标签的枚举 */
+        /**
+         * @description 标签的枚举
+         */
         enums: Array<{
             label: string;
             value: any;
@@ -25,7 +33,9 @@ type Without<T, K> = {
     [P in Exclude<keyof T, K>]?: never;
 };
 type XOR<T extends any[]> = T extends [infer A, infer B, ...infer Rest] ? A | B extends object ? (Without<A, keyof B> & B) | (Without<B, keyof A> & A) | XOR<[A | B, ...Rest]> : A | B : T extends [infer A] ? A : never;
-/** cellFunc中每一项的配置  */
+/**
+ * @description cellFunc中每一项的配置
+ */
 interface ICellProps<T extends keyof TCellComponentPropsMap<J, K>, J extends TXphExtendComponentPropsMap = {}, K extends TXphExtendComponentPropsMap = {}> {
     component: T;
     componentProps?: TCellComponentPropsMap<J, K>[T];
@@ -34,14 +44,10 @@ type TCellFuncPropsMap<J extends TXphExtendComponentPropsMap = {}, K extends TXp
     [T in keyof TCellComponentPropsMap<J, K>]: ICellProps<T, J, K>;
 }[keyof TCellComponentPropsMap<J, K>];
 export type TCellProps<J extends TXphExtendComponentPropsMap = {}, K extends TXphExtendComponentPropsMap = {}> = XOR<[TCellFuncPropsMap<J, K>]>;
-/** CellFunc组件的props */
-export interface ICellFuncProps<
-/** 行数据类型 */
-T = TDataSourceItem, 
-/** 单元格的扩展组件props映射 */
-J extends TXphExtendComponentPropsMap = {}, 
-/** 操作组的扩展组件props映射 */
-K extends TXphExtendComponentPropsMap = {}> {
+/**
+ * @description CellFunc组件的props
+ */
+export interface ICellFuncProps<T = TDataSourceItem, J extends TXphExtendComponentPropsMap = {}, K extends TXphExtendComponentPropsMap = {}> {
     dslConfig: TCellProps<J, K>[];
     renderPrams: {
         text: any;
@@ -50,15 +56,15 @@ K extends TXphExtendComponentPropsMap = {}> {
         column: Omit<IComponentColumnProps<T, K, K>, "cellFunc">;
     };
 }
-/** cellFunc中每一项对应的组件的props */
+/**
+ * @description cellFunc中每一项对应的组件的props
+ */
 export interface ICurCellFuncProps<J extends TXphExtendComponentPropsMap = {}, K extends TXphExtendComponentPropsMap = {}, T extends keyof TCellComponentPropsMap<J, K> = keyof TCellComponentPropsMap<J, K>> {
     curComponentProps?: TCellComponentPropsMap<J, K>[T];
     cellFuncProps: ICellFuncProps<TDataSourceItem, J, K>;
 }
 /**
- *
- * 因为渲染是从cellFuncs中的最后一项开始的，所以mainClick是排在后面的组件传递到前面的
- *
+ * @description 因为渲染是从cellFuncs中的最后一项开始的，所以mainClick是排在后面的组件传递到前面的
  * 目的：目的是为了将自定义组件的点击事件交给最底层的组件进行调用
  * 注意：因为多个自定义组件可能都有mainClick，所以也需要保证其他组件的正常调用（即：传递给子组件Comp的时候，需要把父组件传递过来的mainClick给手动执行一下）
  */

package/dist/types/table/src/types/apiTable.d.ts

@@ -9,47 +9,98 @@ export interface IFunctionToolbarParams<T = TDataSourceItem> {
     loading: boolean;
     selection: T[];
 }
-/** 扩展antd table的属性 */
+/**
+ * @description 扩展antd table的属性
+ */
 export type TApiTableProps<T = TDataSourceItem, J extends TXphExtendComponentPropsMap = {}, K extends TXphExtendComponentPropsMap = {}, L extends TXphExtendComponentPropsMap = {}> = {
-    /** 列配置项 */
+    /**
+     * @default []
+     * @description 列配置项
+     */
     columns?: TColumnProps<T, J, K>[];
-    /** 首次是否自动请求 */
+    /**
+     * @default true
+     * @description 首次是否自动请求
+     */
     autoRequest?: boolean;
-    /** 获取datasource的api */
+    /**
+     * @default -
+     * @description 获取datasource的api
+     */
     api?: (params: any) => Promise<any>;
-    /** 格式化返回的datasource */
+    /**
+     * @default -
+     * @description 格式化返回的datasource
+     */
     formatDataSource?: (data: any) => any[];
-    /** 是否开启前端自动分页（当api不支持分页时可用） */
+    /**
+     * @default -
+     * @description 是否开启前端自动分页（当api不支持分页时可用）
+     */
     autoPagination?: boolean;
-    /** 单选 / 多选 */
+    /**
+     * @default -
+     * @description 单选 / 多选
+     */
     rowSelection?: RowSelectionType | TableRowSelection<T>;
-    /** 分页配置（因为分页器是独立出来的，使用table的分页器布局需要修改样式） */
+    /**
+     * @default { pageSize: 20, total: 0, showTotal: (total) => `共：${total} 条`, current: 1, pageSizeOptions: [10, 20, 50, 100], showSizeChanger: true, showQuickJumper: true, }
+     * @description 分页配置（因为分页器是独立出来的，使用table的分页器布局需要修改样式）
+     */
     pagination?: false | PaginationProps;
-    /** 表格撑满父容器（virtual为true时，默认fullHeight为true） */
+    /**
+     * @default false
+     * @description 表格撑满父容器（virtual为true时，默认fullHeight为true）
+     */
     fullHeight?: boolean;
-    /** 顶部操作栏配置，函数时可以传递参数，参数是什么由调用方决定 */
+    /**
+     * @default -
+     * @description 顶部操作栏配置，函数时可以传递参数，参数是什么由调用方决定
+     */
     toolbar?: IXphActionsProps<L> | ((e: IFunctionToolbarParams<T>) => IXphActionsProps<L>);
-    /** 分页请求参数中传递到接口的属性名 */
+    /**
+     * @default { pageSize: "pageSize", current: "current", }
+     * @description 分页请求参数中传递到接口的属性名
+     */
     requestFields?: {
-        /** 当前页 */
+        /**
+         * @default "current"
+         * @description 当前页
+         */
         current?: string;
-        /** 当前页大小 */
+        /**
+         * @default "pageSize"
+         * @description 当前页大小
+         */
         pageSize?: string;
     };
-    /** 响应结果中获取数据的属性名 */
+    /**
+     * @default { current: "current", list: "data", total: "total", }
+     * @description 响应结果中获取数据的属性名
+     */
     responseFields?: {
-        /** 当前页 */
+        /**
+         * @default "current"
+         * @description 当前页
+         */
         current?: string;
-        /** 列表 */
+        /**
+         * @default "data"
+         * @description 列表
+         */
         list?: string;
-        /** 所有页总数 */
+        /**
+         * @default "total"
+         * @description 所有页总数
+         */
         total?: string;
     };
-    /** 排序、筛选变化时触发 */
+    /**
+     * @default -
+     * @description 排序、筛选变化时触发
+     */
     onChange?: (filters: any, sorter: any, extra: any) => void;
-} & Omit<TableProps<T>, 
-/** 内部控制的属性/重写的属性 */
-"rowSelection" | "columns" | "loading" | "dataSource" | "pagination">;
+} & Omit<TableProps<T>, "rowSelection" | "columns" | "loading" | "dataSource" | "pagination">;
 export type TApiTableActionType = {
     resetAllData: () => Promise<void>;
     resetData: () => Promise<void>;

package/dist/types/table/src/types/column.d.ts

@@ -3,10 +3,14 @@ import { TDataSourceItem } from './table';
 import { TCellProps } from '../components/table/components/cellFunc/types';
 import { TXphExtendComponentPropsMap } from '../../../common';
 
-/** 扩展一下antd column的属性，不一定要扩展，只是预留 */
+/**
+ * @description 扩展一下antd column的属性，不一定要扩展，只是预留
+ */
 type TBaseColumnType<T> = {} & ColumnType<T>;
 export interface IComponentColumnProps<T, J extends TXphExtendComponentPropsMap = {}, K extends TXphExtendComponentPropsMap = {}> extends Omit<TBaseColumnType<T>, "render"> {
-    /** 单元格渲染属性（原理也是使用render渲染不同的内容） */
+    /**
+     * @description 单元格渲染属性（原理也是使用render渲染不同的内容）
+     */
     cellFunc: ((props: {
         text: any;
         record: T;

package/dist/types/table/src/types/crudFormDialog.d.ts

@@ -3,27 +3,30 @@ import { TXphExtendComponentPropsMap, IXphDialogProps, IXphDialogActionType } fr
 
 export type TCrudFormDialogProps<T extends TXphExtendComponentPropsMap = {}> = Omit<IXphDialogProps, "onOk" | "onCancel"> & {
     formProps: IXphFormProps<T>;
-    onOk?: ({ values, data }: {
+    onOk?: (event: {
         values: any;
         data: any;
     }) => Promise<any>;
-    onCancel?: ({ values, data }: {
+    onCancel?: (event: {
         values: any;
         data: any;
     }) => Promise<any>;
 };
 export interface IOpenActionConfig {
-    /** 回填表单的内容 */
+    /**
+     * @description 回填表单的内容
+     */
     data: any;
     /**
      * @description 点击确定的回调(如果弹窗传递了onOk属性就不用传这个了，这个是为了方便所有操作都在open函数中处理)
-     * @param values 表单项的值(如果弹窗传递了onCancel属性就不用传这个了，这个是为了方便所有操作都在close函数中处理)
      */
-    ok?: ({ values }: {
+    ok?: (event: {
         values: any;
     }) => Promise<any>;
-    /** 点击取消的回调 */
-    cancel?: ({ values }: {
+    /**
+     * @description 点击取消的回调(如果弹窗传递了onCancel属性就不用传这个了，这个是为了方便所有操作都在open函数中处理)
+     */
+    cancel?: (event: {
         values: any;
     }) => Promise<any>;
 }

package/dist/types/table/src/types/searchForm.d.ts

@@ -5,6 +5,8 @@ export type TSearchFormActionType = IXphFormActionType & {
     setFormLoading: (loading: boolean) => void;
 };
 export type TSearchFormProps<T extends TXphExtendComponentPropsMap = {}> = IXphFormProps<T> & {
-    /** 是否显示搜索 & 重置按钮 */
+    /**
+     * @description 是否显示搜索 & 重置按钮
+     */
     showSearch?: boolean;
 };

package/dist/types/table/src/types/table.d.ts

@@ -3,29 +3,33 @@ import { ICrudFormDialogActionType, TCrudFormDialogProps } from './crudFormDialo
 import { TApiTableProps, TApiTableActionType } from './apiTable';
 import { TXphExtendComponentPropsMap } from '../../../common';
 
-/** 行数据 */
+/**
+ * @description  行数据
+ */
 export type TDataSourceItem = Record<PropertyKey, any>;
-/** 整个组件的配置 */
-export type TTableProps<
-/** 行数据类型 */
-RecordType = TDataSourceItem, 
-/** 单元格扩展组件props映射 */
-CellFuncExtendPropsMap extends TXphExtendComponentPropsMap = {}, 
-/** 操作组扩展组件props映射 */
-ActionsExtendPropsMap extends TXphExtendComponentPropsMap = {}, 
-/** 顶部操作栏扩展组件props映射 */
-ToolbarExtendPropsMap extends TXphExtendComponentPropsMap = {}, 
-/** 表单扩展组件props映射（包括：搜素表单 & 新增/修改表单） */
-FormExtendPropsMap extends TXphExtendComponentPropsMap = {}> = {
-    /** 表格配置 */
+/**
+ * @description 整个组件的配置
+ */
+export type TTableProps<RecordType = TDataSourceItem, CellFuncExtendPropsMap extends TXphExtendComponentPropsMap = {}, ActionsExtendPropsMap extends TXphExtendComponentPropsMap = {}, ToolbarExtendPropsMap extends TXphExtendComponentPropsMap = {}, FormExtendPropsMap extends TXphExtendComponentPropsMap = {}> = {
+    /**
+     * @description 表格配置
+     */
     table?: TApiTableProps<RecordType, CellFuncExtendPropsMap, ActionsExtendPropsMap, ToolbarExtendPropsMap>;
-    /** 搜索表单配置项 */
+    /**
+     * @description 搜索表单配置项
+     */
     searchForm?: TSearchFormProps<FormExtendPropsMap>;
-    /** （新增 / 修改）表单弹窗配置项 */
+    /**
+     * @description （新增 / 修改）表单弹窗配置项
+     */
     crudFormDialog?: TCrudFormDialogProps<FormExtendPropsMap>;
-    /** 分页改变事件 */
+    /**
+     * @description 分页改变事件
+     */
     onPaginationChange?: (page: number, pageSize: number) => void;
-    /** 列表选中事件 */
+    /**
+     * @description 列表选中事件
+     */
     onRowSelectionChange?: (selectedRowKeys: React.Key[], selectedRows: RecordType[]) => void;
 };
 export type TTableActionType = TApiTableActionType & ICrudFormDialogActionType;

package/package.json

@@ -1,63 +1,63 @@
-{
-  "name": "xph-crud",
-  "version": "0.3.1",
-  "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/types/index.d.ts",
-  "description": "This is a configurable component library based on React",
-  "keywords": [
-    "react",
-    "ant-design",
-    "configurable-component"
-  ],
-  "scripts": {
-    "examples": "vite",
-    "build": "tsc && vite build",
-    "docs": "cd docs && npm run start",
-    "build:docs": "cd docs && npm run build",
-    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0"
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "peerDependencies": {
-    "@ant-design/icons": "5.3.2",
-    "antd": "^5.14.2",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "dayjs": "^1.11.13"
-  },
-  "dependencies": {
-    "lodash-es": "^4.17.21"
-  },
-  "devDependencies": {
-    "@types/lodash-es": "^4.17.12",
-    "@types/node": "^20.14.2",
-    "@types/react": "^18.2.66",
-    "@types/react-dom": "^18.2.22",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
-    "@typescript-eslint/parser": "^7.2.0",
-    "@vitejs/plugin-react": "^4.2.1",
-    "eslint": "^8.57.0",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-refresh": "^0.4.6",
-    "typescript": "^5.2.2",
-    "vite": "^5.2.0",
-    "vite-plugin-dts": "^3.9.1"
-  },
-  "license": "ISC",
-  "author": "XiaoPiHong",
-  "homepage": "https://github.com/XiaoPiHong/xph-crud",
-  "bugs": {
-    "url": "https://github.com/XiaoPiHong/xph-crud/issues",
-    "email": "260094892@qq.com"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/XiaoPiHong/xph-crud.git"
-  },
-  "engines": {
-    "node": ">=16"
-  }
-}
+{
+  "name": "xph-crud",
+  "version": "0.3.2",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/types/index.d.ts",
+  "description": "This is a configurable component library based on React",
+  "keywords": [
+    "react",
+    "ant-design",
+    "configurable-component"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@ant-design/icons": "5.3.2",
+    "antd": "^5.14.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "dayjs": "^1.11.13"
+  },
+  "dependencies": {
+    "lodash-es": "^4.17.21"
+  },
+  "devDependencies": {
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^20.14.2",
+    "@types/react": "^18.2.66",
+    "@types/react-dom": "^18.2.22",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/parser": "^7.2.0",
+    "@vitejs/plugin-react": "^4.2.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.6",
+    "typescript": "^5.2.2",
+    "vite": "^5.2.0",
+    "vite-plugin-dts": "^3.9.1"
+  },
+  "license": "ISC",
+  "author": "XiaoPiHong",
+  "homepage": "https://github.com/XiaoPiHong/xph-crud",
+  "bugs": {
+    "url": "https://github.com/XiaoPiHong/xph-crud/issues",
+    "email": "260094892@qq.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XiaoPiHong/xph-crud.git"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "examples": "vite",
+    "build": "tsc && vite build",
+    "docs": "cd docs && npm run start",
+    "build:docs": "cd docs && npm run build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0"
+  }
+}

package/dist/types/common/src/componnets/actions/types/actions.d.ts

@@ -1,18 +0,0 @@
-import { TActionItemProps } from './actionItem';
-import { ButtonProps } from 'antd/lib/button';
-import { TXphExtendComponentPropsMap } from '../../../types';
-
-export interface IActionsProps<T extends TXphExtendComponentPropsMap = {}> {
-    /** 类型 */
-    type?: ButtonProps["type"];
-    /** 操作项 */
-    items?: TActionItemProps<T>[];
-    /** 禁用（items中的componentProps的disabled优先级最高） */
-    disabled?: boolean;
-    /** 自定义内容（items的优先级高于render） */
-    render?: React.ReactElement;
-    /** 超过多少个item自动省略，默认是10（其余全部放在一个dropdown中） */
-    max?: number;
-    /** 是否需要从扩展中继承属性（可能有些特殊情况，不需要使用扩展中的属性） */
-    inherit?: boolean;
-}

package/dist/types/common/src/componnets/dialog/types/dialog.d.ts

@@ -1,32 +0,0 @@
-import { ButtonProps } from 'antd';
-
-export interface IDialogProps {
-    width?: number;
-    height?: number;
-    mask?: boolean;
-    title?: string;
-    okProps?: Omit<ButtonProps, "children" | "onClick">;
-    cancelProps?: Omit<ButtonProps, "children" | "onClick">;
-    okText?: string;
-    cancelText?: string;
-    /** 点击确定按钮触发该事件 */
-    onOk?: (args: any) => Promise<void>;
-    /** 点击取消按钮触发该事件 */
-    onCancel?: (args: any) => Promise<void>;
-    renderFooter?: ({ loading }: {
-        loading: boolean;
-    }) => React.ReactElement;
-    renderTitle?: () => React.ReactElement;
-    /** 打开的时候会触发该事件 */
-    onOpen?: () => void;
-    /** 关闭的时候会触发该事件 */
-    onClose?: () => void;
-    /** 挂载弹窗的容器，默认是body */
-    getPopperContainer?: () => HTMLElement | null;
-}
-export interface IDialogActionType {
-    open: () => Promise<void>;
-    close: () => void;
-    setLoading: (loading: boolean) => void;
-    getVisible: () => boolean;
-}