xph-crud 0.3.2 → 0.3.3

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

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

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

@@ -6,4 +6,7 @@ import { default as XphPortal } from './portal/portal';
 import { default as XphAuth } from './auth/auth';
 import { IAuthProps as IXphAuthProps } from './auth/types';
 
+export * from './actions/types';
+export * from './auth/types';
+export * from './dialog/types';
 export { XphActions, TXphActionItemProps, IXphActionsProps, XphDialog, IXphDialogProps, IXphDialogActionType, XphPortal, XphAuth, IXphAuthProps, };

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

@@ -1,6 +1,6 @@
 /**
- * 自定义 Hook 用于异步更新状态
- * @param initialState 初始状态
+ * @description 自定义 Hook 用于异步更新状态
+ * @param initialState - 初始状态
  * @returns [state, setAsyncState] state 是当前状态，setAsyncState 是更新状态的函数
  */
 export declare const useAsyncState: <T>(initialState: T) => [T, (newState: T) => Promise<void>];

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

@@ -1,3 +1,6 @@
+/**
+ * @description Helper function to get value by path
+ */
 export declare const getValueByPath: (obj: Record<string, any>, path: string) => any;
 /**
  * @description 通过属性为包含.的字符串的对象从值对象中获取值

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

@@ -1 +1,4 @@
+/**
+ * @description 生成随机数
+ */
 export declare function buildUUID(): string;

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

@@ -2,4 +2,5 @@ import { default as XphForm } from './src/form';
 import { IFormProps as IXphFormProps, IFormActionType as IXphFormActionType, TFormItemProps as TXphFormItemProps } from './src/types';
 import { useForm as useXphForm } from './src/hooks';
 
+export * from './src/types';
 export { XphForm, IXphFormProps, TXphFormItemProps, IXphFormActionType, useXphForm, };

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

@@ -2,7 +2,7 @@ import { RuleObject } from 'antd/es/form';
 import { TComponentPropsMap, TFormItemProps } from './types';
 
 /**
- * @description: 生成placeholder
+ * @description 生成placeholder
  */
 export declare function createPlaceholderMessage(component: keyof TComponentPropsMap): "" | "请输入" | "请选择";
 export declare function setComponentRuleType(rule: RuleObject, component: keyof TComponentPropsMap, valueFormat: string): void;

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

@@ -1,15 +1,12 @@
 /**
- * 该钩子解决的问题：
+ * @description 该钩子解决的问题：
  * 1、使用了Form.useWatch的FormItem，至少都会触发两次组件更新，导致api首次请求的情况不一致
  * 2、每次value的更新，都会导致组件的重新渲染，导致api每次都会请求（处理成当params不一致才重新请求）
- */
-/**
- *
- * @param api 请求的api
- * @param apiCallback 请求之后的回调
- * @param immediate 首次是否立即执行apiCallback
- * @param params 请求的参数
- * @param isUseWatch 是否使用了Form.useWatch
+ * @param api - 请求的api
+ * @param apiCallback - 请求之后的回调
+ * @param immediate - 首次是否立即执行apiCallback
+ * @param params - 请求的参数
+ * @param isUseWatch - 是否使用了Form.useWatch
  */
 interface IUseComonentCacheProps {
     api?: (...args: any[]) => Promise<any>;

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

@@ -13,7 +13,7 @@ export declare const useFormModel: (formProps: IFormProps, itemProps: TFormItemP
 /**
  *
  * @description 用于注册form的方法
- * @description form组件会先于parent组件挂载，挂载完后调用register方法，将methods注册到useForm中给parent使用
+ * form组件会先于parent组件挂载，挂载完后调用register方法，将methods注册到useForm中给parent使用
  *
  */
 declare const useForm: () => [IRegister, IFormActionType];

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

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

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

@@ -9,73 +9,73 @@ export type Recordable<T> = Record<string, T>;
 export type TFunction<T> = T | ((args: Recordable<any>) => T);
 export interface IBaseFormItemProps {
     /**
-     * @default -
-     * @description 字段名
+     * 字段名
+     * @defaultValue `-`
      */
     name: string;
     /**
-     * @default -
-     * @description 标签名
+     * 标签名
+     * @defaultValue `-`
      */
     label: string;
     /**
-     * @default -
-     * @description 子节点的值的属性，如 Switch、Checkbox 的是 checked
+     * 子节点的值的属性，如 Switch、Checkbox 的是 checked
+     * @defaultValue `-`
      */
     valuePropName?: string;
     /**
-     * @default -
-     * @description 是否显示（相当于display:none）
+     * 是否显示（相当于display:none）
+     * @defaultValue `-`
      */
     show?: TFunction<boolean>;
     /**
-     * @default -
-     * @description 是否显示（会新增或删除节点）
+     * 是否显示（会新增或删除节点）
+     * @defaultValue `-`
      */
     ifShow?: TFunction<boolean>;
     /**
-     * @default -
-     * @description 是否必填
+     * 是否必填
+     * @defaultValue `-`
      */
     required?: TFunction<boolean>;
     /**
-     * @default -
-     * @description 是否禁用（当和 Form 同时设置时，以 Item 为准）
+     * 是否禁用（当和 Form 同时设置时，以 Item 为准）
+     * @defaultValue `-`
      */
     disabled?: TFunction<boolean>;
     /**
-     * @default -
-     * @description 组件属性
+     * 组件属性
+     * @defaultValue `-`
      */
     componentProps?: TFunction<Recordable<any>>;
     /**
-     * @default -
-     * @description 校验规则
+     * 校验规则
+     * @defaultValue `-`
      */
     rules?: Rule[];
     /**
-     * @default -
-     * @description 表单项组件的布局方式（当和 Form 同时设置时，以 Item 为准）
+     * 表单项组件的布局方式（当和 Form 同时设置时，以 Item 为准）
+     * @defaultValue `-`
      */
     wrapperCol?: ColProps;
     /**
-     * @default -
-     * @description 表单项label标签布局方式（当和 Form 同时设置时，以 Item 为准）
+     * 表单项label标签布局方式（当和 Form 同时设置时，以 Item 为准）
+     * @defaultValue `-`
      */
     labelCol?: ColProps;
     /**
-     * @default -
-     * @description 表单项的栅格配置（当和 Form 同时设置时，以 Item 为准）
+     * 表单项的栅格配置（当和 Form 同时设置时，以 Item 为准）
+     * @defaultValue `-`
      */
     colProps?: ColProps;
     /**
-     * @default -
-     * @description 是否强制换一行显示该表单项（强制换行后续会跟随换行表单项）
+     * 是否强制换一行显示该表单项（强制换行后续会跟随换行表单项）
+     * @defaultValue `-`
      */
     forceRow?: boolean;
     /**
-     * @default -
-     * @description 默认值
+     * 默认值
+     * @defaultValue `-`
      */
     initialValue?: any;
 }
@@ -84,23 +84,23 @@ export interface IBaseFormItemProps {
  */
 export interface IFRenderProps {
     /**
-     * @description 当前项name
+     * 当前项name
      */
     name: string;
     /**
-     * @description 当前项状态
+     * 当前项状态
      */
     disabled: boolean;
     /**
-     * @description 组件属性
+     * 组件属性
      */
     componentProps: Recordable<any>;
     /**
-     * @description 表单值
+     * 表单值
      */
     model: any;
     /**
-     * @description 表单方法实例
+     * 表单方法实例
      */
     methods: IFormActionType;
 }
@@ -109,7 +109,8 @@ export interface IFRenderProps {
  */
 export interface IRenderFormItemProps extends IBaseFormItemProps {
     /**
-     * @description 自定义渲染函数
+     * 自定义渲染函数
+     * @defaultValue `-`
      */
     render: (props: IFRenderProps) => React.ReactNode;
 }
@@ -118,7 +119,8 @@ export interface IRenderFormItemProps extends IBaseFormItemProps {
  */
 export interface IComponentFormItemProps<T extends TXphExtendComponentPropsMap = {}> extends IBaseFormItemProps {
     /**
-     * @description 映射组件
+     * 映射组件
+     * @defaultValue `-`
      */
     component: keyof TComponentPropsMap<T>;
 }

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

@@ -1,5 +1,6 @@
 import { default as XphTable } from './src/table';
 import { default as XphCrudFormDialog } from './src/components/crudFormDialog';
-import { TTableProps as TXphTableProps, TTableActionType as TXphTableActionType, TDataSourceItem as TXphDataSourceItem, TColumnProps as TXphColumnProps, TApiTableProps as TXphApiTableProps, TSearchFormProps as TXphSearchFormProps, IMainProps as IXphMainProps, TCrudFormDialogProps as TXphCrudFormDialogProps } from './src/types';
+import { TTableProps as TXphTableProps, TTableActionType as TXphTableActionType, TDataSourceItem as TXphDataSourceItem, TColumnProps as TXphColumnProps, TApiTableProps as TXphApiTableProps, TSearchFormProps as TXphSearchFormProps, IMainProps as IXphMainProps, TCrudFormDialogProps as TXphCrudFormDialogProps, ICrudFormDialogActionType as IXphCrudFormDialogActionType } from './src/types';
 
-export { XphTable, TXphTableProps, TXphTableActionType, TXphDataSourceItem, TXphColumnProps, TXphApiTableProps, TXphSearchFormProps, IXphMainProps, XphCrudFormDialog, TXphCrudFormDialogProps, };
+export * from './src/types';
+export { XphTable, TXphTableProps, TXphTableActionType, TXphDataSourceItem, TXphColumnProps, TXphApiTableProps, TXphSearchFormProps, IXphMainProps, XphCrudFormDialog, TXphCrudFormDialogProps, IXphCrudFormDialogActionType, };

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

@@ -7,18 +7,18 @@ import { IComponentColumnProps, TDataSourceItem } from '../../../../../types';
 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;
@@ -69,8 +69,17 @@ export interface ICurCellFuncProps<J extends TXphExtendComponentPropsMap = {}, K
  * 注意：因为多个自定义组件可能都有mainClick，所以也需要保证其他组件的正常调用（即：传递给子组件Comp的时候，需要把父组件传递过来的mainClick给手动执行一下）
  */
 export interface IMainProps {
+    /**
+     * 点击事件
+     */
     mainClick?: () => void;
+    /**
+     * 内容样式
+     */
     mainStyle?: React.CSSProperties;
+    /**
+     * 内容
+     */
     mainHandleText?: () => any;
 }
 export {};