xph-crud 0.3.1 → 0.3.3

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: {
-        /** 超链接，点击超链接跳转 */
+        /**
+         * 超链接，点击超链接跳转
+         */
         url?: string;
-        /** 点击事件（优先级最高） */
+        /**
+         * 点击事件（优先级最高）
+         */
         onClick?: () => void;
     };
     actions: IXphActionsProps<ActionsExtendPropsMap>;
     tag: {
-        /** 标签的枚举 */
+        /**
+         * 标签的枚举
+         */
         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,21 +56,30 @@ 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给手动执行一下）
  */
 export interface IMainProps {
+    /**
+     * 点击事件
+     */
     mainClick?: () => void;
+    /**
+     * 内容样式
+     */
     mainStyle?: React.CSSProperties;
+    /**
+     * 内容
+     */
     mainHandleText?: () => any;
 }
 export {};

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

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

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渲染不同的内容） */
+    /**
+     * 单元格渲染属性（原理也是使用render渲染不同的内容）
+     */
     cellFunc: ((props: {
         text: any;
         record: T;

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

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

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

@@ -2,9 +2,14 @@ import { IXphFormProps, IXphFormActionType } from '../../../form';
 import { TXphExtendComponentPropsMap } from '../../../common';
 
 export type TSearchFormActionType = IXphFormActionType & {
+    /**
+     * 设置表单的loading
+     */
     setFormLoading: (loading: boolean) => void;
 };
 export type TSearchFormProps<T extends TXphExtendComponentPropsMap = {}> = IXphFormProps<T> & {
-    /** 是否显示搜索 & 重置按钮 */
+    /**
+     * 是否显示搜索 & 重置按钮
+     */
     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 = {}> = {
+    /**
+     * 表格配置
+     */
     table?: TApiTableProps<RecordType, CellFuncExtendPropsMap, ActionsExtendPropsMap, ToolbarExtendPropsMap>;
-    /** 搜索表单配置项 */
+    /**
+     * 搜索表单配置项
+     */
     searchForm?: TSearchFormProps<FormExtendPropsMap>;
-    /** （新增 / 修改）表单弹窗配置项 */
+    /**
+     * （新增 / 修改）表单弹窗配置项
+     */
     crudFormDialog?: TCrudFormDialogProps<FormExtendPropsMap>;
-    /** 分页改变事件 */
+    /**
+     * 分页改变事件
+     */
     onPaginationChange?: (page: number, pageSize: number) => void;
-    /** 列表选中事件 */
+    /**
+     * 列表选中事件
+     */
     onRowSelectionChange?: (selectedRowKeys: React.Key[], selectedRows: RecordType[]) => void;
 };
 export type TTableActionType = TApiTableActionType & ICrudFormDialogActionType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xph-crud",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",

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;
-}