@zat-design/sisyphus-react 3.11.14-beta.5 → 3.11.14-beta.7

package/es/ProThemeTools/propsType.d.ts

@@ -1,50 +1,172 @@
 export interface DevToolsPropsType {
+    /**
+     * @description 重置配置回调函数
+     * @default -
+     */
     onReset: () => void;
+    /**
+     * @description 关闭工具回调函数
+     * @default -
+     */
     onClose: () => void;
+    /**
+     * @description 复制配置回调函数
+     * @default -
+     */
     onCopy?: () => void;
+    /**
+     * @description 设置状态函数
+     * @default -
+     */
     setState: any;
+    /**
+     * @description 是否打开工具
+     * @default false
+     */
     open: boolean;
-    state: LocalThemeConfigPropsType;
-    /** 是否有表格边框 */
+    /**
+     * @description 当前主题配置状态
+     * @default -
+     */
+    state: LocalThemeConfigType;
+    /**
+     * @description 是否有表格边框
+     * @default false
+     */
     tableBorder?: boolean;
-    /** 是否有斑马纹 */
+    /**
+     * @description 是否有斑马纹
+     * @default false
+     */
     tableStripe?: boolean;
-    /** 统一样式前缀, 默认ant */
+    /**
+     * @description 统一样式前缀
+     * @default "ant"
+     */
     prefixCls?: string;
 }
-export interface ProThemeToolsProps {
+export interface ProThemeToolsType {
+    /**
+     * @description 主题工具大小
+     * @default -
+     */
     size?: number;
+    /**
+     * @description 主题颜色
+     * @default -
+     */
     color?: string;
+    /**
+     * @description 工具模式：开发模式或生产模式
+     * @default "prd"
+     */
     mode?: 'dev' | 'prd';
+    /**
+     * @description 缓存时间，可设置为数字或布尔值
+     * @default -
+     */
     cacheTime?: number | boolean;
-    /** 主题配置信息 */
+    /**
+     * @description 主题配置信息
+     * @default -
+     */
     theme?: any;
-    /** icon是否跟随主题色 */
+    /**
+     * @description icon是否跟随主题色
+     * @default false
+     */
     iconFollowTheme?: boolean;
-    /** 是否有表格边框 */
+    /**
+     * @description 是否有表格边框
+     * @default false
+     */
     tableBorder?: boolean;
-    /** 是否有斑马纹 */
+    /**
+     * @description 是否有斑马纹
+     * @default false
+     */
     tableStripe?: boolean;
-    /** 统一样式前缀, 默认ant */
+    /**
+     * @description 统一样式前缀
+     * @default "ant"
+     */
     prefixCls?: string;
+    /**
+     * @description 主题变更回调函数
+     * @default -
+     */
     onChange?: (record: any) => void;
+    /**
+     * @description 允许扩展字段
+     */
     [key: string]: any;
 }
-export interface LocalThemeConfigPropsType {
+export interface LocalThemeConfigType {
+    /**
+     * @description 品牌色
+     * @default -
+     */
     zauiBrand?: string;
+    /**
+     * @description 文本色
+     * @default -
+     */
     zauiText?: string;
+    /**
+     * @description 字体大小
+     * @default -
+     */
     zauiFontSize?: string;
+    /**
+     * @description 表单对齐方式
+     * @default -
+     */
     zauiFormAlign?: string;
+    /**
+     * @description 表单必填项后缀
+     * @default -
+     */
     zauiFormRequiredAfter?: string;
+    /**
+     * @description 表单必填项前缀
+     * @default -
+     */
     zauiFormRequiredBefore?: string;
+    /**
+     * @description 尺寸大小
+     * @default -
+     */
     zauiSize?: number;
+    /**
+     * @description 大间距
+     * @default -
+     */
     zauiSpaceSizeLg?: string;
+    /**
+     * @description 中间距
+     * @default -
+     */
     zauiSpaceSizeMd?: string;
-    /** 大字号模式 */
+    /**
+     * @description 大字号模式
+     * @default false
+     */
     zauiBigText?: boolean;
-    /** 是否有表格边框 */
+    /**
+     * @description 是否有表格边框
+     * @default false
+     */
     zauiTableBorder?: boolean;
-    /** 是否有斑马纹 */
+    /**
+     * @description 是否有斑马纹
+     * @default false
+     */
     zauiStripe?: boolean;
+    /**
+     * @description 基础字体大小
+     * @default -
+     */
     zauiBaseFontSize?: string;
 }
+export type ProThemeToolsProps = ProThemeToolsType;
+export type LocalThemeConfigPropsType = LocalThemeConfigType;

package/es/ProUpload/components/ButtonRender.d.ts

@@ -1,7 +1,7 @@
 import { FC, ReactNode } from 'react';
 import { UploadFile } from 'antd';
-import { ProUploadProps } from '../propsType';
-interface DragRenderProps extends Pick<ProUploadProps, 'buttonProps' | 'disabled' | 'maxCount' | 'extraTipText' | 'buttonText'> {
+import type { ProUploadType } from '../propsType';
+interface DragRenderProps extends Pick<ProUploadType, 'buttonProps' | 'disabled' | 'maxCount' | 'extraTipText' | 'buttonText'> {
     isView?: boolean;
     headerRender: () => ReactNode;
     footerRender: () => ReactNode;

package/es/ProUpload/components/DraggableUploadListItem.d.ts

@@ -1,2 +1,2 @@
-import { DraggableUploadListItemProps } from '../propsType';
-export declare const DraggableUploadListItem: ({ file, children }: DraggableUploadListItemProps) => import("react/jsx-runtime").JSX.Element;
+import type { DraggableUploadListItemType } from '../propsType';
+export declare const DraggableUploadListItem: ({ file, children }: DraggableUploadListItemType) => import("react/jsx-runtime").JSX.Element;

package/es/ProUpload/components/Example.d.ts

@@ -1,10 +1,10 @@
 import React from 'react';
-import { ExampleModalProps } from '../propsType';
+import type { ExampleModalType } from '../propsType';
 interface ExampleProps {
     exampleContent?: React.ReactNode;
     className?: string;
     exampleTitle?: string | React.ReactNode;
-    exampleModalProps?: ExampleModalProps;
+    exampleModalProps?: ExampleModalType;
 }
 export declare const Example: React.FC<ExampleProps>;
 export {};

package/es/ProUpload/components/ImageRender.d.ts

@@ -1,7 +1,7 @@
 import { FC, ReactNode } from 'react';
 import { UploadFile } from 'antd/es/upload/interface';
-import { ProUploadProps } from '../propsType';
-interface DragRenderProps extends Pick<ProUploadProps, 'buttonProps' | 'disabled' | 'maxCount' | 'extraTipText' | 'showExampleContent' | 'exampleTitle' | 'exampleContent' | 'exampleModalProps'> {
+import type { ProUploadType } from '../propsType';
+interface DragRenderProps extends Pick<ProUploadType, 'buttonProps' | 'disabled' | 'maxCount' | 'extraTipText' | 'showExampleContent' | 'exampleTitle' | 'exampleContent' | 'exampleModalProps'> {
     isView?: boolean;
     headerRender: () => ReactNode;
     footerRender: () => ReactNode;

package/es/ProUpload/index.d.ts

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

package/es/ProUpload/index.js

@@ -208,13 +208,6 @@ var ProUpload = /*#__PURE__*/React.forwardRef(function (props, ref) {
     }
     return headerRender;
   };
-  // 自定义顶部
-  // const _centerRender = () => {
-  //   if (isFunction(centerRender)) {
-  //     return centerRender();
-  //   }
-  //   return centerRender;
-  // };
   // 自定义底部
   var _footerRender = function _footerRender() {
     if (isFunction(footerRender)) {

package/es/ProUpload/propsType.d.ts

@@ -2,22 +2,56 @@ 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           -
@@ -52,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           -
@@ -169,7 +203,7 @@ export interface ProUploadProps {
      * @description 上传接口处理方法 返回一个数组 UploadFile【】
      * @default    -
      */
-    transformResponse?: (res: any) => UploadFileRes;
+    transformResponse?: (res: any) => UploadFileResType;
     /**
      * @description 可以调用组件的内部方法，例如：uploadStart方式
      * @default    -
@@ -189,12 +223,16 @@ export interface ProUploadProps {
      * @description 文件对象的字段映射
      * @default    true
      */
-    fieldNames?: fieldNamesProps;
+    fieldNames?: fieldNamesType;
     /**
      * @description 删除已经上传的文件时是否二次提示
      * @default    false
      */
     isConfirmDelete?: boolean;
+    /**
+     * @description 组件ID
+     * @default    -
+     */
     id?: string;
     /**
      * @description 查看模式
@@ -207,7 +245,20 @@ export interface ProUploadProps {
      */
     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/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 { PropSelectType } from '../ProSelect/propsType';
+import { ProModalSelectType } from '../ProForm/components/combination/ProModalSelect/propsType';
+import { ProCascaderType } from '../ProForm/components/combination/ProCascader/propsType';
 import { 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/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;