xph-crud 0.3.2 → 0.3.3

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

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

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

@@ -9,7 +9,7 @@ import { TXphExtendComponentPropsMap } from '../../../common';
 type TBaseColumnType<T> = {} & ColumnType<T>;
 export interface IComponentColumnProps<T, J extends TXphExtendComponentPropsMap = {}, K extends TXphExtendComponentPropsMap = {}> extends Omit<TBaseColumnType<T>, "render"> {
     /**
-     * @description 单元格渲染属性（原理也是使用render渲染不同的内容）
+     * 单元格渲染属性（原理也是使用render渲染不同的内容）
      */
     cellFunc: ((props: {
         text: any;

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

@@ -2,11 +2,20 @@ 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>;
+    /**
+     * crud弹窗点击确定的回调
+     */
     onOk?: (event: {
         values: any;
         data: any;
     }) => Promise<any>;
+    /**
+     * crud弹窗点击取消回调
+     */
     onCancel?: (event: {
         values: any;
         data: any;
@@ -14,22 +23,23 @@ export type TCrudFormDialogProps<T extends TXphExtendComponentPropsMap = {}> = O
 };
 export interface IOpenActionConfig {
     /**
-     * @description 回填表单的内容
+     * 回填表单的内容
      */
     data: any;
     /**
-     * @description 点击确定的回调(如果弹窗传递了onOk属性就不用传这个了，这个是为了方便所有操作都在open函数中处理)
+     * 点击确定的回调(如果弹窗传递了onOk属性就不用传这个了，这个是为了方便所有操作都在open函数中处理)
      */
     ok?: (event: {
         values: any;
     }) => Promise<any>;
     /**
-     * @description 点击取消的回调(如果弹窗传递了onCancel属性就不用传这个了，这个是为了方便所有操作都在open函数中处理)
+     * 点击取消的回调(如果弹窗传递了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,11 +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> & {
     /**
-     * @description 是否显示搜索 & 重置按钮
+     * 是否显示搜索 & 重置按钮
      */
     showSearch?: boolean;
 };

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

@@ -12,23 +12,23 @@ export type TDataSourceItem = Record<PropertyKey, any>;
  */
 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;
 };

package/package.json

@@ -1,63 +1,63 @@
-{
-  "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"
-  }
-}
+{
+  "name": "xph-crud",
+  "version": "0.3.3",
+  "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"
+  }
+}