@zat-design/sisyphus-react 3.11.14-beta.8 → 3.11.14-beta.9

package/es/ProTooltip/index.d.ts

@@ -1,4 +1,4 @@
-import { ProTooltipPropsType } from './propsType';
+import type { ProTooltipType } from './propsType';
 import './style/index.less';
-declare const ProTooltip: (props: ProTooltipPropsType) => import("react/jsx-runtime").JSX.Element;
+declare const ProTooltip: (props: ProTooltipType) => import("react/jsx-runtime").JSX.Element;
 export default ProTooltip;

package/es/ProTooltip/propsType.d.ts

@@ -1,19 +1,62 @@
-import React from 'react';
-export interface ProTooltipPropsType {
-    text?: string | React.ReactNode;
+import { ReactNode, CSSProperties } from 'react';
+export interface ProTooltipType {
+    /**
+     * 提示文本内容
+     * @description 支持字符串或React节点
+     * @default undefined
+     */
+    text?: string | ReactNode;
+    /**
+     * 提示框宽度
+     * @description 设置提示框的宽度，支持各种CSS宽度单位
+     * @default 'auto'
+     */
     width?: string;
+    /**
+     * 显示的行数
+     * @description 当内容超过设定行数时将截断显示
+     * @default 1
+     */
     line?: number;
+    /**
+     * 是否响应式宽度
+     * @description 启用后提示框宽度将根据内容自适应
+     * @default false
+     */
     isResponsiveWidth?: Boolean;
+    /**
+     * 自定义类名
+     * @description 额外的CSS类名
+     * @default ''
+     */
     className?: string;
-    children?: React.ReactNode;
-    /** 样式 */
-    style?: React.CSSProperties;
-    /** 兼容 */
+    /**
+     * 子元素
+     * @description 组件包裹的内容
+     * @default null
+     */
+    children?: ReactNode;
+    /**
+     * 自定义样式对象
+     * @description 直接应用于组件的内联样式
+     * @default {}
+     */
+    style?: CSSProperties;
+    /**
+     * 兼容属性
+     * @description 支持传入其他属性
+     */
     [key: string]: any;
 }
-export interface RefObjectPropsType<T> {
+export interface ProTooltipRefObjectType<T> {
+    /** 当前引用的DOM元素 */
     readonly current: T | null;
 }
-export type ProtooltipTriggerNodeType = HTMLElement & {
+export type ProTooltipTriggerNodeType = HTMLElement & {
+    /** 父节点元素 */
     parentNode: HTMLElement;
 };
+export type ProTooltipPropsType = ProTooltipType;
+export type ProTooltipProps = ProTooltipType;
+export type RefObjectPropsType<T> = ProTooltipRefObjectType<T>;
+export type ProtooltipTriggerNodeType = ProTooltipTriggerNodeType;

package/es/ProTree/components/ProTreeSelect/propsType.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import type { TreeSelectProps } from 'antd';
 import { Service, Options, Result } from 'ahooks/lib/useRequest/src/types';
-import { ProFormOtherProps } from '../../../ProForm/propsType';
+import { ProFormOtherType } from '../../../ProForm/propsType';
 export interface DataProps {
     label: string;
     value?: string;
@@ -62,7 +62,7 @@ export interface PropTreeSelectProps extends Omit<TreeSelectProps, 'onSearch'> {
     /** 是否展示 code-label 形式 */
     showCodeName?: boolean;
     /** 集成表单 form 的属性 */
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     onSearch?: (value: string, useRequest: Result<any, any>) => void;
     /** 远程请求接口 */
     useRequest?: {

package/es/ProTree/components/SearchTitle.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="react" />
-import { ProFormOtherProps } from '../../ProForm/propsType';
+import { ProFormOtherType } from '../../ProForm/propsType';
 declare function SearchTitle(props: {
     searchStr?: string;
     label?: string;
     showEllipse?: boolean;
     ellipseWidth?: string;
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
 }): import("react/jsx-runtime").JSX.Element;
 declare const _default: import("react").MemoExoticComponent<typeof SearchTitle>;
 export default _default;

package/es/ProTree/propsType.d.ts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 import { Service, Options, Result } from 'ahooks/lib/useRequest/src/types';
 import type { TreeSelectProps } from 'antd';
-import { ProFormOtherProps } from '../ProForm/propsType';
+import { ProFormOtherType } from '../ProForm/propsType';
 export interface TreeDataProps {
     label?: string;
     value?: string;
@@ -76,7 +76,7 @@ export interface ProTreeProps extends PropTreeSelectProps {
     transformResponse?: (data: any) => TreeDataProps[];
     /** tags 集合 */
     tags?: string[];
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     /** 远程请求接口 */
     useRequest?: {
         service: Service<any, any>;
@@ -186,7 +186,7 @@ export interface PropTreeSelectProps extends Omit<TreeSelectProps, 'onSearch'> {
     /** 是否展示 code-label 形式 */
     showCodeName?: boolean;
     /** 集成表单 form 的属性 */
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     onSearch?: (value: string, useRequest: Result<any, any>) => void;
     /** 远程请求接口 */
     useRequest?: {

package/es/ProTreeModal/propsType.d.ts

@@ -1,6 +1,6 @@
 import { ReactNode, CSSProperties } from 'react';
 import { Service, Options } from 'ahooks/lib/useRequest/src/types';
-import { ProFormOtherProps } from '../ProForm/propsType';
+import { ProFormOtherType } from '../ProForm/propsType';
 export interface TreeDataProps {
     label: string;
     value: string;
@@ -74,7 +74,7 @@ export interface ProTreeModalProps {
     style?: CSSProperties;
     /** tags 集合 */
     tags?: string[];
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     /** 远程请求接口 */
     useRequest?: {
         service?: Service<any, any>;

package/es/ProUpload/propsType.d.ts

@@ -29,7 +29,7 @@ export interface ExampleModalType {
      */
     [key: string]: any;
 }
-export interface fieldNamesType {
+export interface FieldNamesType {
     /**
      * @description 文件唯一标识字段
      * @default -
@@ -223,7 +223,7 @@ export interface ProUploadType {
      * @description 文件对象的字段映射
      * @default    true
      */
-    fieldNames?: fieldNamesType;
+    fieldNames?: FieldNamesType;
     /**
      * @description 删除已经上传的文件时是否二次提示
      * @default    false
@@ -259,6 +259,6 @@ export interface DraggableUploadListItemType {
 }
 export type UploadFileRes = UploadFileResType;
 export type ExampleModalProps = ExampleModalType;
-export type fieldNamesProps = fieldNamesType;
+export type fieldNamesProps = FieldNamesType;
 export type ProUploadProps = ProUploadType;
 export type DraggableUploadListItemProps = DraggableUploadListItemType;

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 { 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/propsType.d.ts

@@ -2,7 +2,7 @@ import { InputProps } from 'antd/es/input';
 import { PopconfirmProps } from 'antd/es/popconfirm';
 import { FormInstance } from 'antd/es/form';
 import React from 'react';
-import { ProColumnProps } from '../index';
+import { ProColumnType } from '../index';
 export interface ContainerType {
     /**
      * @description 触发方式
@@ -77,7 +77,7 @@ export interface PopupType {
      * @description 列配置
      * @default -
      */
-    columns?: ProColumnProps;
+    columns?: ProColumnType;
     /**
      * @description 允许扩展字段
      */

package/lib/ProEditTable/components/Summary/index.d.ts

@@ -1,8 +1,8 @@
-import { SummaryColumnProps } from '../../propsType';
+import { SummaryColumnType } from '../../propsType';
 interface SummaryProps<T = any> {
     data: T[];
     summary: {
-        columns: SummaryColumnProps[];
+        columns: SummaryColumnType[];
         total?: boolean;
         fixed?: boolean | 'top' | 'bottom';
     };

package/lib/ProEditTable/index.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
-import { ProEditTableProps, ProEditTableRefProps } from './propsType';
-declare const ForwardProEditTable: React.ForwardRefExoticComponent<Omit<ProEditTableProps<any>, "ref"> & React.RefAttributes<ProEditTableRefProps>>;
+import { ProEditTableType } from './propsType';
+declare const ForwardProEditTable: React.ForwardRefExoticComponent<Omit<ProEditTableType<any>, "ref"> & React.RefAttributes<import("./propsType").ProEditTableRefProps>>;
 export default ForwardProEditTable;