@zat-design/sisyphus-react 3.11.14 → 3.12.0

package/es/ProUpload/propsType.d.ts

@@ -1,22 +1,57 @@
 import React from 'react';
 import { UploadFile } from 'antd/es/upload/interface';
+import { UploadRequestOption } from 'rc-upload/lib/interface';
 export type UploadType = 'drag' | 'button' | 'image';
-export interface UploadFileRes {
+export interface UploadFileResType {
+    /**
+     * @description 上传文件返回的URL
+     * @default -
+     */
     url: string;
+    /**
+     * @description 允许扩展字段
+     */
     [key: string]: any;
 }
-export interface ExampleModalProps {
+export interface ExampleModalType {
+    /**
+     * @description 弹窗宽度
+     * @default -
+     */
     width?: string | number;
+    /**
+     * @description 弹窗外层容器类名
+     * @default -
+     */
     wrapClassName?: string;
+    /**
+     * @description 允许扩展字段
+     */
     [key: string]: any;
 }
-export interface fieldNamesProps {
+export interface FieldNamesType {
+    /**
+     * @description 文件唯一标识字段
+     * @default -
+     */
     uid?: number;
+    /**
+     * @description 文件名称字段
+     * @default -
+     */
     name?: string;
+    /**
+     * @description 文件URL字段
+     * @default -
+     */
     url?: string;
+    /**
+     * @description 文件状态字段
+     * @default -
+     */
     status?: 'done' | 'uploading' | 'error';
 }
-export interface ProUploadProps {
+export interface ProUploadType {
     /**
      * @description       顶部的内容(button类型的上传不适用)
      * @default           -
@@ -51,7 +86,7 @@ export interface ProUploadProps {
      * @description       示例弹窗的属性配置继承与antd 的Modal对话框
      * @default           -
      */
-    exampleModalProps?: ExampleModalProps;
+    exampleModalProps?: ExampleModalType;
     /**
      * @description       接受上传的文件类型, '.png,.jpeg,.jpg,.xlsx,.xls,.json,.doc,.docx' 详见 input accept Attribute
      * @default           -
@@ -168,7 +203,7 @@ export interface ProUploadProps {
      * @description 上传接口处理方法 返回一个数组 UploadFile【】
      * @default    -
      */
-    transformResponse?: (res: any) => UploadFileRes;
+    transformResponse?: (res: any) => UploadFileResType;
     /**
      * @description 可以调用组件的内部方法，例如：uploadStart方式
      * @default    -
@@ -188,20 +223,42 @@ export interface ProUploadProps {
      * @description 文件对象的字段映射
      * @default    true
      */
-    fieldNames?: fieldNamesProps;
+    fieldNames?: FieldNamesType;
     /**
      * @description 删除已经上传的文件时是否二次提示
      * @default    false
      */
     isConfirmDelete?: boolean;
+    /**
+     * @description 组件ID
+     * @default    -
+     */
     id?: string;
     /**
      * @description 查看模式
      * @default    false
      */
     isView?: boolean;
+    /**
+     * @description 自定义上传实现
+     * @default    false
+     */
+    customRequest?: (option: UploadRequestOption) => void;
 }
-export interface DraggableUploadListItemProps {
+export interface DraggableUploadListItemType {
+    /**
+     * @description 文件对象
+     * @default -
+     */
     file: UploadFile<any>;
+    /**
+     * @description 子元素
+     * @default -
+     */
     children: React.ReactNode;
 }
+export type UploadFileRes = UploadFileResType;
+export type ExampleModalProps = ExampleModalType;
+export type fieldNamesProps = FieldNamesType;
+export type ProUploadProps = ProUploadType;
+export type DraggableUploadListItemProps = DraggableUploadListItemType;

package/es/ProWaterMark/index.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
-import { ProWaterMarkProps } from './propsType';
-declare const ProWaterMark: React.FC<ProWaterMarkProps>;
+import type { ProWaterMarkType } from './propsType';
+declare const ProWaterMark: React.FC<ProWaterMarkType>;
 export default ProWaterMark;

package/es/ProWaterMark/propsType.d.ts

@@ -1,4 +1,4 @@
-export interface ProWaterMarkProps {
+export interface ProWaterMarkType {
     /**
      * @description       水印是否显示
      * @default           true
@@ -80,3 +80,4 @@ export interface ProWaterMarkProps {
      */
     mode?: 'repeat' | 'interval';
 }
+export type ProWaterMarkProps = ProWaterMarkType;

package/es/index.d.ts

@@ -9,7 +9,7 @@ export { default as ProEditTable } from './ProEditTable';
 export { default as ProDrawerForm } from './ProDrawerForm';
 export { default as ProEditLabel } from './ProEditLabel';
 export { default as ProForm } from './ProForm';
-export * from './ProForm';
+export { ProFormProvider } from './ProForm';
 export * from './ProForm/components';
 export { default as ProSelect } from './ProSelect';
 export { default as ProEnum } from './ProEnum';
@@ -26,9 +26,18 @@ export * from './locale';
 export { default as ProBackBtn } from './ProLayout/components/ProHeader/components/ProBackBtn';
 export { default as ProEditableTable } from './old/ProEditableTable';
 export { default as ProCertValidity } from './old/ProCertValidity';
-export * from './ProForm/propsType';
-export * from './ProTable/propsType';
-export * from './ProEditTable/propsType';
-export * from './ProUpload/propsType';
-export * from './ProTabs/propType';
+export type { ProFormType, ProColumnProps, ProFormColumnType } from './ProForm/propsType';
+export type { ProFormComponentType } from './ProForm/components/index.d';
+export type { ProTableType, ProTableColumnType, ProTableSummaryType, ProTableUseAntdTableType, ProTableProps, ProTableSummaryProps, ProTableColumn, UseAntdTableState } from './ProTable/propsType';
+export type { ProUploadType, ProUploadProps } from './ProUpload/propsType';
+export type { ProTabsType, ProTabsItemType, ProTabsProps, ProTabsItemsProps } from './ProTabs/propType';
+export type { BreadcrumbColumnType, SubDescribeColumnType, DescribeColumnType, ProHeaderType, ProHeaderProps, BreadcrumbColumnsProps, SubDescribeColumnsProps, DescribeColumnsProps } from './ProLayout/components/ProHeader/PropTypes';
+export type { ProTooltipType, ProTooltipProps } from './ProTooltip/propsType';
+export type { ProIconType, ProIconProps } from './ProIcon/propsTypes';
+export type { ProTreeType, ProTreeSelectType, ProTreeProps, PropTreeSelectProps } from './ProTree/propsType';
+export type { ProTreeModalType, ProTreeModalActionType, ProTreeModalProps, ProTreeModalAction } from './ProTreeModal/propsType';
+export type { ProEditTableType, ProEditTableColumnType, ProEditTableSummaryColumnType, ProEditTableSummaryConfigType, ProEditTableActionType, ProEditTableProps, ProEditTableColumnsProps, SummaryProps, SummaryColumnProps, BaseActionProps } from './ProEditTable/propsType';
+export type { ProStepType, ProStepContextType, ProStepItemType, ProStepPropsType, ProStepItemPropsType } from './ProStep/propsType';
+export type { ProDrawerFormType, ProDrawerFormPropsType } from './ProDrawerForm/propsType';
+export type { ProModalSelectType, ProModalSelectConfigType, ProModalSelectPropsType } from './ProForm/components/combination/ProModalSelect/propsType';
 export * from './tokens';

package/es/index.js

@@ -13,7 +13,7 @@ export { default as ProDrawerForm } from './ProDrawerForm';
 export { default as ProEditLabel } from './ProEditLabel';
 // 表单
 export { default as ProForm } from './ProForm';
-export * from './ProForm';
+export { ProFormProvider } from './ProForm';
 export * from './ProForm/components'; // ProForm 中组件导出
 export { default as ProSelect } from './ProSelect';
 export { default as ProEnum } from './ProEnum';
@@ -32,11 +32,5 @@ export * from './locale';
 export { default as ProBackBtn } from './ProLayout/components/ProHeader/components/ProBackBtn';
 export { default as ProEditableTable } from './old/ProEditableTable';
 export { default as ProCertValidity } from './old/ProCertValidity';
-// TS类型导出
-export * from './ProForm/propsType';
-export * from './ProTable/propsType';
-export * from './ProEditTable/propsType';
-export * from './ProUpload/propsType';
-export * from './ProTabs/propType';
 // token导出
 export * from './tokens';

package/lib/ProAction/index.d.ts

@@ -1,7 +1,7 @@
 import React, { PropsWithChildren } from 'react';
-import { ActionProps } from './propsType';
+import type { ProActionType } from './propsType';
 import './index.less';
 declare const ProAction: React.FC<PropsWithChildren<{
-    config?: ActionProps[];
+    config?: ProActionType[];
 }>>;
 export default ProAction;

package/lib/ProAction/propsType.d.ts

@@ -1,27 +1,31 @@
 import { ReactNode } from 'react';
 import { Service, Options } from 'ahooks/lib/useRequest/src/types';
-export interface ActionProps {
+export interface ProActionType {
     /**
-     * check 执行校验并解析错误信息展示
-     * confirm 确认提示
+     * @description 模式类型：check执行校验并解析错误信息展示，confirm确认提示
+     * @default -
      */
     mode?: 'check' | 'confirm';
     /**
-     * 标题
+     * @description 标题
+     * @default -
      */
     title?: string | ReactNode;
     /**
-     *
+     * @description 操作回调函数
      * @param previouData 接上一个 useRequest 返回的值
      * @param args 接所有链式 useRequest 返回的值
-     * @returns
+     * @param index 当前操作的索引
+     * @returns void或Promise<void>
+     * @default -
      */
     onAction?: (previouData?: any, args?: any[], index?: number) => void | Promise<void>;
     /**
-     * 自定义请求
+     * @description 自定义请求
      * @param previouData 接上一个 useRequest 返回的值
      * @param args 接所有链式 useRequest 返回的值
-     * @returns
+     * @returns 包含service、options和transformResponse的对象
+     * @default -
      */
     useRequest?: (previouData: any, args: any) => {
         service?: Service<any, any>;
@@ -29,10 +33,12 @@ export interface ActionProps {
         transformResponse?: (data: any) => any;
     };
     /**
-     * 是否中断链式操作
+     * @description 是否中断链式操作
      * @param previouData 上一个操作的返回数据
      * @param args 所有链式的数据合集
-     * @returns
+     * @returns 布尔值，返回true继续执行，返回false中断操作
+     * @default -
      */
     continue?: (previouData: any, args: any[]) => boolean;
 }
+export type ProActionProps = ProActionType;

package/lib/ProConfigProvider/index.d.ts

@@ -1,15 +1,15 @@
 import React, { FC } from 'react';
 import { FormInstance } from 'antd';
-import { PropSelectProps } from '../ProSelect/propsType';
-import { ProModalSelectPropsType } from '../ProForm/components/combination/ProModalSelect/propsType';
-import { ProCascaderProps } from '../ProForm/components/combination/ProCascader/propsType';
-import { ProEnumConfig } from '../ProEnum/propsType';
+import type { PropSelectType } from '../ProSelect/propsType';
+import type { ProModalSelectType } from '../ProForm/components/combination/ProModalSelect/propsType';
+import type { ProCascaderType } from '../ProForm/components/combination/ProCascader/propsType';
+import type { ProEnumConfig } from '../ProEnum/propsType';
 export interface ProConfigState {
     locale?: string;
     ProEnum?: Partial<ProEnumConfig>;
-    ProSelect?: Partial<PropSelectProps> & Record<string, any>;
-    ProModalSelect?: Partial<ProModalSelectPropsType> & Record<string, any>;
-    ProAddressBar?: Partial<ProCascaderProps> & Record<string, any>;
+    ProSelect?: Partial<PropSelectType> & Record<string, any>;
+    ProModalSelect?: Partial<ProModalSelectType> & Record<string, any>;
+    ProAddressBar?: Partial<ProCascaderType> & Record<string, any>;
     forms: Record<string, FormInstance | undefined>;
     [key: string]: any;
 }

package/lib/ProDownload/index.d.ts

@@ -1,6 +1,6 @@
-import { IProDownloadProps } from './propsType';
+import type { ProDownloadType } from './propsType';
 declare const ProDownload: {
-    (props: IProDownloadProps): import("react/jsx-runtime").JSX.Element;
+    (props: ProDownloadType): import("react/jsx-runtime").JSX.Element;
     downLoadRequest: import("./utils").DownloadRequestProps;
 };
 export default ProDownload;

package/lib/ProDownload/propsType.d.ts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 import type { ButtonProps } from 'antd';
 import type { DownloadRequestProps, PropsWithMakeFilePropsType } from './utils';
-export interface IProDownloadProps extends ButtonProps {
+export interface ProDownloadType extends ButtonProps {
     /**
      * @description       下载资源获取来源：api：通过接口获取，url：通过静态资源链接获取
      * @default           api
@@ -69,3 +69,4 @@ export interface IProDownloadProps extends ButtonProps {
     children?: string | ReactNode;
     [key: string]: any;
 }
+export type IProDownloadProps = ProDownloadType;

package/lib/ProDrawerForm/components/ProDrawer/index.d.ts

@@ -1,7 +1,7 @@
 import { FC } from 'react';
-import { ProDrawerFormPropsType } from '../../propsType';
+import { ProDrawerFormType } from '../../propsType';
 /**
  * 抽屉组件
  */
-declare const ProDrawer: FC<ProDrawerFormPropsType>;
+declare const ProDrawer: FC<ProDrawerFormType>;
 export default ProDrawer;

package/lib/ProDrawerForm/components/ProModal/index.d.ts

@@ -1,7 +1,7 @@
 import { FC } from 'react';
-import { ProDrawerFormPropsType } from '../../propsType';
+import { ProDrawerFormType } from '../../propsType';
 /**
  * 弹窗组件
  */
-declare const ProModal: FC<ProDrawerFormPropsType>;
+declare const ProModal: FC<ProDrawerFormType>;
 export default ProModal;

package/lib/ProDrawerForm/index.d.ts

@@ -1,5 +1,4 @@
 import React from 'react';
 import { FormInstance } from 'antd/es/form/Form';
-import { ProDrawerFormPropsType } from './propsType';
-declare const ProDrawerForm: React.ForwardRefExoticComponent<ProDrawerFormPropsType & React.RefAttributes<FormInstance<any>>>;
+declare const ProDrawerForm: React.ForwardRefExoticComponent<import("./propsType").ProDrawerFormPropsType & React.RefAttributes<FormInstance<any>>>;
 export default ProDrawerForm;

package/lib/ProDrawerForm/propsType.d.ts

@@ -1,17 +1,26 @@
 import React, { ReactNode } from 'react';
 import type { ModalProps, DrawerProps, FormInstance } from 'antd';
-import { ProFormProps } from '../ProForm/propsType';
+import type { ProFormType } from '../ProForm/propsType';
+/**
+ * 抽屉尺寸类型定义
+ */
 export type DrawerSizePropsType = 'small' | 'middle' | 'large';
+export type DrawerSizeType = DrawerSizePropsType;
+/**
+ * 显示类型定义
+ */
 export type ShowTypePropsType = 'Modal' | 'Drawer';
-export interface ProDrawerFormRef {
-    form: FormInstance<any>;
-}
+export type ShowType = ShowTypePropsType;
+/**
+ * 为了保持向后兼容，保留原有接口名称
+ * @deprecated ProDrawerFormType
+ */
 export interface ProDrawerFormPropsType {
-    /** @name 内部form */
+    /** @name 内部form实例 */
     form?: FormInstance<any>;
     /** @name 自定义className */
     className?: string;
-    /** @name 控制显示隐藏 */
+    /** @name 控制显示隐藏（兼容旧版API） */
     visible?: ModalProps['open'] | DrawerProps['open'];
     /** @name 控制显示隐藏 */
     open: ModalProps['open'] | DrawerProps['open'];
@@ -25,30 +34,22 @@ export interface ProDrawerFormPropsType {
     isView?: boolean | undefined;
     /** @name 宽度 */
     width?: ModalProps['width'] | DrawerProps['width'];
-    /**
-     * @name 取消按钮文字
-     */
+    /** @name 取消按钮文字 */
     cancelText?: ModalProps['cancelText'];
-    /**
-     * @name 确认按钮文字
-     */
+    /** @name 确认按钮文字 */
     okText?: ModalProps['okText'];
-    /**
-     * @name 确认按钮loading
-     */
+    /** @name 确认按钮loading状态 */
     okLoading?: boolean;
-    /**
-     * @name 确认按钮disabled
-     */
+    /** @name 确认按钮禁用状态 */
     okDisabled?: boolean;
     /** @name 显示方式 (废弃) */
-    showType?: ShowTypePropsType;
+    showType?: ShowType;
     /** @name 显示方式 */
-    mode?: ShowTypePropsType;
+    mode?: ShowType;
     /** @name 尺寸 */
-    size?: DrawerSizePropsType;
+    size?: DrawerSizeType;
     /**
-     * @name自动选中第一项
+     * @name 自动选中第一项
      * @description 只对有input的类型有效
      */
     autoFocusFirstInput?: boolean;
@@ -64,10 +65,14 @@ export interface ProDrawerFormPropsType {
     isConfirmCloseModalProps?: ModalProps;
     /**
      * @name 底部默认取消按钮事件
+     * @returns 返回Promise或布尔值可控制弹窗关闭行为
      */
     onCancel?: () => Promise<boolean | void | unknown> | boolean | void | unknown;
     /**
      * @name 底部默认确定按钮事件
+     * @param values 表单值
+     * @param form 表单实例
+     * @returns 返回Promise或布尔值可控制弹窗关闭行为
      */
     onOk?: (values?: any, form?: FormInstance) => Promise<boolean | void | unknown> | boolean | void | unknown;
     /**
@@ -79,24 +84,30 @@ export interface ProDrawerFormPropsType {
      */
     extraLeft?: ReactNode;
     /**
-     * @name proForm的属性 配置后children不展示
+     * @name proForm的属性
+     * @description 配置后children不展示
      */
-    proFormProps?: Omit<ProFormProps, 'form'>;
+    proFormProps?: Omit<ProFormType, 'form'>;
     /**
-     * 不支持 'visible'，请使用全局的 visible
      * @name 弹框的属性
+     * @description 不支持'visible'，请使用全局的visible/open
      */
     modalProps?: Omit<ModalProps, 'visible'>;
     /**
-     * 不支持 'visible'，请使用全局的 visible
      * @name 抽屉的属性
+     * @description 不支持'visible'，请使用全局的visible/open
      */
     drawerProps?: Omit<DrawerProps, 'visible'>;
     /**
-     * 不支持 'visible'，请使用全局的 visible
      * @name 关闭时弹框或者抽屉是否清空formValues
      */
     onCloseClean?: boolean;
+    /** @name 子组件 */
     children?: React.ReactNode;
+    /** @name z轴层级 */
     zIndex?: number;
 }
+/**
+ * 抽屉表单属性类型定义
+ */
+export type ProDrawerFormType = ProDrawerFormPropsType;

package/lib/ProDrawerForm/utils/index.d.ts

@@ -1,6 +1,6 @@
-import { DrawerSizePropsType } from '../propsType';
+import { DrawerSizeType } from '../propsType';
 /**
  * 将枚举值转成数值px，暴露枚举，隐藏真实数值，暂时不让用户自定义
  * @param size 设计规范的三个尺寸  460 960 1200 对应 'small' | 'middle' | 'large'
  */
-export declare const transformBySize: (size: DrawerSizePropsType) => number;
+export declare const transformBySize: (size: DrawerSizeType) => number;

package/lib/ProEditLabel/components/RenderProForm.d.ts

@@ -1,4 +1,4 @@
 import { FC } from 'react';
-import type { PopupProps } from '../propsType';
-declare const RenderProForm: FC<PopupProps>;
+import type { PopupType } from '../propsType';
+declare const RenderProForm: FC<PopupType>;
 export default RenderProForm;

package/lib/ProEditLabel/index.d.ts

@@ -1,4 +1,4 @@
 import { FC } from 'react';
-import { ContainerProps, LabelProps, PopupConfirmProps } from './propsType';
-declare const ProEditLabel: FC<LabelProps & PopupConfirmProps & ContainerProps>;
+import type { ContainerType, LabelType, ProEditLabelType } from './propsType';
+declare const ProEditLabel: FC<LabelType & ProEditLabelType & ContainerType>;
 export default ProEditLabel;