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

package/lib/ProEditTable/propsType.d.ts

@@ -7,9 +7,16 @@ import type { NamePath } from 'antd/es/form/interface';
 import type { ColumnType, TableProps } from 'antd/es/table';
 import type { FormInstance, FormItemProps } from 'antd/es/form';
 import type { FunctionArgs, ProRule } from '../ProForm/propsType';
-import { ProFormValueType, ColumnPropsMap } from '../ProForm/components/render/propsType';
+import { ProFormValueType, ColumnTypeMap } from '../ProForm/components/render/propsType';
 import { DiffOriginalParams } from '../ProForm/utils/diffOriginal';
+/**
+ * 操作类型定义
+ */
 export type ActionType = 'edit' | 'delete' | 'save' | 'cancel' | 'add' | 'mulDelete' | 'custom';
+/**
+ * 操作按钮展示控制函数类型
+ * @template T 记录类型
+ */
 export type ShowFunction<T> = (record?: T, options?: {
     index: number;
     form: FormInstance;
@@ -18,264 +25,396 @@ export type ShowFunction<T> = (record?: T, options?: {
     tableLength: number;
     selectedRows: T[];
 }) => Promise<any> | boolean | void;
+/**
+ * 选项属性接口
+ */
 export interface OptionsProps {
+    /** 索引 */
     index: number;
+    /** 表单实例 */
     form: FormInstance;
+    /** 名称路径 */
     namePath: NamePath;
+    /** 名称 */
     name: NamePath;
 }
+/**
+ * 选项属性类型（基于接口）
+ */
+export type OptionsType = OptionsProps;
+/**
+ * 汇总列属性
+ */
 export interface SummaryColumnProps {
+    /** 列唯一标识 */
     key: string;
+    /** 列索引 */
     index: number;
+    /** 列标题 */
     title?: string;
+    /** 跨列数 */
     colSpan?: number;
+    /** 值类型 */
     valueType?: string;
+    /** 精度 */
     precision?: number;
+    /** 前缀 */
     prefix?: ReactNode | string;
 }
+/**
+ * 汇总列属性类型（基于接口）
+ */
+export type SummaryColumnType = SummaryColumnProps;
+/**
+ * 基础操作按钮属性
+ * @template T 记录类型
+ */
 export interface BaseActionProps<T = any> {
     /**
-     * @description       按钮类型
-     * @default           -
+     * 按钮类型
      */
     type?: ActionType;
     /**
-     * @description       按钮名称
-     * @default           -
+     * 按钮名称
      */
     label?: string | ReactNode;
     /**
-     * @description       是否显示按钮
-     * @default           true
+     * 是否显示按钮
+     * @default true
      */
     show?: boolean | ShowFunction<T>;
     /**
-   * @description       是否持久化（一直显示）操作按钮
-   * @default           true
-   */
+     * 是否持久化（一直显示）操作按钮
+     * @default true
+     */
     persistence?: boolean;
     /**
-     * @description       是否禁止操作
-     * @default           true
+     * 是否禁止操作
+     * @default true
      */
     disabled?: boolean | ShowFunction<T>;
     /**
-     * @description       添加是否自定义打开弹框
-     * @default           false
+     * 添加是否自定义打开弹框
+     * @default false
      */
     isSelectModal?: boolean;
     /**
-     * @description       删除是否开启二次确认
-     * @default           true
+     * 删除是否开启二次确认
+     * @default true
      */
     needConfirm?: boolean;
     /**
-     * @description       按钮是否禁止操作
-     * @default           -
+     * 按钮是否禁止操作
      */
     isEditable?: boolean;
     /**
-     * @description       按钮前置校验事件
-     * @default           -
+     * 按钮前置校验事件
      */
     onClick?: (record?: any, index?: number) => any;
     /**
-     * @description       按钮前置校验事件
-     * @default           -
+     * 按钮前置校验事件
      */
     onHandle?: (record?: any, index?: number) => any;
     /**
-     * @description       支持antd的Button属性
-     * @default           -
+     * 支持antd的Button属性
      */
     buttonProps?: Omit<ButtonProps, 'type' | 'onClick'>;
 }
+/**
+ * 基础操作按钮类型（基于接口）
+ * @template T 记录类型
+ */
+export type BaseActionType<T = any> = BaseActionProps<T>;
+/**
+ * 规则函数类型
+ * @template T 记录类型
+ */
 export type RulesFn<T> = (text?: any, record?: T, options?: OptionsProps) => ProRule[] | void;
+/**
+ * 必填函数类型
+ * @template T 记录类型
+ */
 export type RequiredFn<T> = (text?: any, record?: T, options?: OptionsProps) => boolean | void;
+/**
+ * 视图渲染函数类型
+ * @template T 记录类型
+ */
 export type viewRenderFn<T> = (text?: any, record?: T, options?: OptionsProps) => string | number | ReactNode | void;
+/**
+ * 表格列属性接口
+ * @template Values 值类型
+ * @template T 记录类型
+ */
 export interface ProColumnsProps<Values = any, T = any> extends Omit<FormItemProps<Values>, 'rules' | 'required'>, ColumnType<Values> {
+    /** 是否必填 */
     required?: boolean | RequiredFn<T>;
+    /** 标签是否必填 */
     labelRequired?: boolean;
+    /** 字段名 */
     name?: NamePath;
+    /** 多字段名 */
     names?: NamePath[];
+    /** 是否可编辑 */
     isEditable?: boolean | RequiredFn<T>;
+    /** 值类型 */
     valueType?: ProFormValueType | ((text?: any, record?: any, options?: OptionsProps) => ProFormValueType);
+    /** 提示信息 */
     tooltip?: string | ({
         icon?: string | ReactNode;
     } & TooltipProps);
+    /** 组件 */
     component?: string | number | ReactNode | viewRenderFn<T>;
+    /** 视图渲染 */
     viewRender?: string | number | ReactNode | viewRenderFn<T>;
+    /** 隐藏的字段名 */
     hiddenNames?: NamePath[] | NamePath[][];
+    /** 校验规则 */
     rules?: ProRule[] | RulesFn<T>;
+    /** 确认操作 */
     confirm?: boolean | ModalFuncProps | FunctionArgs<Values, boolean | ModalFuncProps | void>;
+    /** 依赖项 */
     dependencies?: NamePath[];
+    /** 差异处理 */
     onDiff?: DiffOriginalParams['onDiff'];
     [key: string]: any;
 }
-export type ProEditTableColumnsProps<K = any> = ProColumnsProps & ColumnPropsMap<K, 'ProEditTable'>;
+/**
+ * 表格列属性类型（基于接口）
+ * @template Values 值类型
+ * @template T 记录类型
+ */
+export type ProColumnsType<Values = any, T = any> = ProColumnsProps<Values, T>;
+/**
+ * 可编辑表格列属性
+ * @template K 键类型
+ */
+export type ProEditTableColumnsProps<K = any> = ProColumnsProps & ColumnTypeMap<K, 'ProEditTable'>;
+/**
+ * 可编辑表格列属性类型（基于类型）
+ * @template K 键类型
+ */
+export type ProEditTableColumnsType<K = any> = ProEditTableColumnsProps<K>;
+/**
+ * 状态接口
+ */
 export interface State {
+    /** 单元格名称路径 */
     cellNamePath: NamePath[];
+    /** 表格内部强制刷新开关 */
     forceUpdate: {};
+    /** 正在编辑行的row-key集合 */
     editingKeys: string[];
+    /** 当前选中行的row-key集合 */
     selectedRowKeys: Key[];
+    /** 当前选中行数据集合 */
     selectedRows: any[];
+    /** 虚拟键 */
     virtualKey: string;
+    /** 分页信息 */
     page: {
         pageNum: number;
         pageSize: number;
     };
 }
+/**
+ * 状态类型（基于接口）
+ */
+export type StateType = State;
+/**
+ * 可编辑表格引用属性
+ */
 export interface ProEditTableRefProps {
-    getInternalState: () => State;
+    /** 获取内部状态 */
+    getInternalState: () => StateType;
 }
+/**
+ * 可编辑表格引用属性类型（基于接口）
+ */
+export type ProEditTableRefType = ProEditTableRefProps;
+/**
+ * 可编辑表格模式类型
+ */
+export type ProEditTableMode = 'single' | 'multiple' | 'cell';
+export type ProEditTableModeType = ProEditTableMode;
+/**
+ * 表格插入类型
+ */
+export type InsertType = 'before' | 'after';
+/**
+ * 操作按钮方向
+ */
+export type ActionDirection = 'vertical' | 'horizontal';
+export type ActionDirectionType = ActionDirection;
+/**
+ * 汇总信息配置
+ * @template T 记录类型
+ */
+export type SummaryConfig<T> = {
+    columns: SummaryColumnType[];
+    total?: boolean;
+    fixed?: boolean | 'top' | 'bottom';
+} | TableProps<T>['summary'];
+export type SummaryConfigType<T = any> = SummaryConfig<T>;
+/**
+ * 可编辑表格属性接口
+ * @template T 记录类型
+ */
 export interface ProEditTableProps<T = any> extends Omit<TableProps<T>, 'onChange' | 'summary'> {
     /**
-     * @description       可编辑表格的 form 实例，使用 Form.useForm 生成后使用
-     * @default           -
+     * 可编辑表格的 form 实例，使用 Form.useForm 生成后使用
      */
     form?: FormInstance;
     /**
-     * @description       原始数据源，设置后可以对比更新后的数值
-     * @default           -
+     * 原始数据源，设置后可以对比更新后的数值
      */
     originalValues?: any;
     /**
-     * @description       原始数据源，是否tooltip显示
-     * @default           -
+     * 可编辑表格的模式
+     * @default multiple
      */
-    mode?: 'single' | 'multiple' | 'cell';
+    mode?: ProEditTableModeType;
     /**
-     * @description       可编辑表格的类型，单行编辑或者多行编辑
-     * @deprecated        将于下个版本 4.0.0 被弃用
-     * @default           multiple
+     * 可编辑表格的类型，单行编辑或者多行编辑
+     * @deprecated 将于下个版本 4.0.0 被弃用
+     * @default multiple
      */
-    type?: 'single' | 'multiple' | 'cell';
+    type?: ProEditTableModeType;
     /**
-     * @description       必填对齐方式, 默认右对齐
-     * @default           right
+     * 必填对齐方式, 默认右对齐
+     * @default right
      */
     requiredAlign?: 'left' | 'right';
     /**
-     * @description       同 dataSource，传入一个数组,是 table 渲染的元数据
-     * @default           undefined
+     * 同 dataSource，传入一个数组,是 table 渲染的元数据
+     * @default undefined
      */
     value?: T[];
     /**
-     * @description       dataSource 修改时触发，删除和修改都会触发,如果设置了 value，ProEditTable 会成为一个受控组件
-     * @default           -
+     * dataSource 修改时触发，删除和修改都会触发,如果设置了 value，ProEditTable 会成为一个受控组件
      */
     onChange?: (list: T[]) => void;
     /**
-     * @description       表格列的配置描述，扩展了FormItemProps属性
-     * @default           []
+     * 表格列的配置描述，扩展了FormItemProps属性
+     * @default []
      */
     columns: ProEditTableColumnsProps[];
     /**
-     * @description       是否禁止编辑
-     * @default           false
+     * 是否禁止编辑
+     * @default false
      */
     disabled?: boolean;
     /**
-     * @description       是否开启斑马纹
-     * @default           true
+     * 是否开启斑马纹
+     * @default true
      */
     stripe?: boolean;
     /**
-     * @description       可编辑表格新增时数据插入方式，头部插入或者尾部插入
-     * @default           after
+     * 可编辑表格新增时数据插入方式，头部插入或者尾部插入
+     * @default after
      */
-    insertType?: 'before' | 'after';
+    insertType?: InsertType;
     /**
-     * @description       字段名，支持数组
-     * @default          -
+     * 字段名，支持数组
      */
     name?: string | number | (string | number)[];
     /**
-     * @description       是否可拖拽排序
-     * @default           -
+     * 是否可拖拽排序
      */
     draggable?: boolean;
     /**
-   * @description       是否开启虚拟列表（scroll,x,y必须为固定值）
-   * @default           -
-   */
+     * 是否开启虚拟列表（scroll,x,y必须为固定值）
+     */
     virtual?: boolean;
     /**
-     * @description       空列表状态时，自定义添加按钮
-     * @default          点击添加
+     * 空列表状态时，自定义添加按钮
+     * @default 点击添加
      */
     emptyBtnText?: string;
     /**
-     * @description       只能编辑一行的的提示
-     * @default          请先保存数据
+     * 只能编辑一行的的提示
+     * @default 请先保存数据
      */
     onlyOneLineMsg?: string;
     /**
-     * @description       单行删除时弹出的确认框提示消息
-     * @default          您确定要删除该行数据吗？
+     * 单行删除时弹出的确认框提示消息
+     * @default 您确定要删除该行数据吗？
      */
     deletePoConfirmMsg?: string;
     /**
-     * @description       多行删除时弹出的确认框提示消息
-     * @default          您确定要删除选中的数据吗？
+     * 多行删除时弹出的确认框提示消息
+     * @default 您确定要删除选中的数据吗？
      */
     mulDeletePoConfirmMsg?: string;
     /**
-     * @description       自定义编辑模式的操作栏 单行编辑默认为编辑、删除、保存、取消；多行编辑为删除
-     * @default           -
+     * 自定义编辑模式的操作栏宽度
      */
     actionWidth?: ColumnType<T>['width'];
     /**
-     * @description       自定义编辑模式的操作栏 单行编辑默认为编辑、删除、保存、取消；多行编辑为删除
-     * @default           -
+     * 自定义编辑模式的操作栏 单行编辑默认为编辑、删除、保存、取消；多行编辑为删除
      */
-    actionProps?: BaseActionProps<T>[] | boolean;
+    actionProps?: BaseActionType<T>[] | boolean;
     /**
-     * @description       自定义 table footer 左侧渲染, 配置后toolbarProps会失效
-     * @default           -
+     * 自定义 table footer 左侧渲染, 配置后toolbarProps会失效
      */
     footerRender?: ReactNode;
     /**
-     * @description       自定义底部操作栏 默认为添加、删除（批量）
-     * @default           -
+     * 自定义底部操作栏 默认为添加、删除（批量）
      */
-    toolbarProps?: BaseActionProps<T>[] | boolean;
+    toolbarProps?: BaseActionType<T>[] | boolean;
     /**
-     *  @description      自定义底部操作栏跟随页面滚动
-     *  @default           -
+     * 自定义底部操作栏跟随页面滚动
      */
     toolbarSticky?: boolean | Omit<AffixProps, 'children'>;
     /**
-     * @description       最大可添加数量
-     * @default           -
+     * 最大可添加数量
      */
     max?: number;
     /**
-     * @description       formItem的props
-     * @default           -
+     * formItem的props
      */
     otherProps?: any;
     /**
-     * @description       底部合计配置
-     * @default           -
+     * 底部合计配置
      */
-    summary?: {
-        columns: SummaryColumnProps[];
-        total?: boolean;
-        fixed?: boolean | 'top' | 'bottom';
-    } | TableProps<T>['summary'];
+    summary?: SummaryConfigType<T>;
     /**
-     * @description       底部合计配置
-     * @default           -
+     * 自定义头部渲染
      */
     headerRender?: ReactNode;
+    /**
+     * 行是否禁用
+     */
     rowDisabled?: (record?: T) => string | boolean;
+    /**
+     * 行是否可拖拽
+     */
     rowDraggable?: (record?: T) => string | boolean;
+    /**
+     * 拖拽事件处理
+     */
     onDrag?: (event: DragEndEvent, dataSource: T[]) => T[];
+    /**
+     * 引用对象
+     */
     ref?: any;
-    actionDirection?: 'vertical' | 'horizontal';
+    /**
+     * 操作按钮方向
+     */
+    actionDirection?: ActionDirectionType;
+    /**
+     * 校验触发方式
+     */
     validateTrigger?: string | string[];
+    /**
+     * 差异配置
+     */
     diffConfig?: {
+        /** 是否跟随父元素滚动 */
         scrollFollowParent?: boolean;
     };
 }
+/**
+ * 可编辑表格属性类型（基于接口）
+ * @template T 记录类型
+ */
+export type ProEditTableType<T = any> = ProEditTableProps<T>;

package/lib/ProEnum/propsType.d.ts

@@ -1,7 +1,7 @@
 import React, { ReactNode } from 'react';
 import { RadioProps, CheckboxProps } from 'antd';
 import { Service, Options } from 'ahooks/lib/useRequest/src/types';
-import { ProFormOtherProps } from '../index';
+import { ProFormOtherType } from '../index';
 import { PropSelectProps } from '../ProSelect/propsType';
 /**
  * @description 数据选项类型
@@ -212,7 +212,7 @@ export interface ProEnumBaseType {
      * @description 其他表单属性
      * @default -
      */
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     /**
      * @description 是否允许清除
      * @default false

package/lib/ProForm/components/FormFooter/index.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { FooterRenderProps } from './propsType';
+import { FooterRenderType } from './propsType';
 export declare const PRO_FORM_CACHE = "PRO_FORM_CACHE";
-declare const FormFooter: React.FC<FooterRenderProps>;
+declare const FormFooter: React.FC<FooterRenderType>;
 export default FormFooter;

package/lib/ProForm/components/FormFooter/propsType.d.ts

@@ -2,18 +2,23 @@ import { ButtonProps, ColProps, FormInstance } from 'antd';
 export interface ButtonItem extends ButtonProps {
     children?: any;
 }
-export interface FooterButtonProps {
+export interface FooterButtonType {
     okButtonProps?: ButtonItem;
     cancelButtonProps?: ButtonItem;
 }
-export interface FooterRenderProps {
+export interface FooterRenderType {
     okText?: string;
     cancelText?: string;
     onOk?: () => void;
     onCancel?: () => void;
     footerColProps?: ColProps;
-    footer?: FooterButtonProps;
+    footer?: FooterButtonType;
     confirmLoading?: boolean;
     formId?: string;
     form: FormInstance;
 }
+/**
+ * 兼容旧命名导出
+ */
+export type FooterButtonProps = FooterButtonType;
+export type FooterRenderProps = FooterRenderType;

package/lib/ProForm/components/base/Checkbox/index.d.ts

@@ -1,13 +1,13 @@
 import React from 'react';
 import { CheckboxGroupProps } from 'antd/es/checkbox';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends Omit<CheckboxGroupProps, 'options'> {
     dataSource: any[];
     fieldNames?: {
         label: string;
         value: string;
     };
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const Checkbox: React.FC<Props>;

package/lib/ProForm/components/base/Input/index.d.ts

@@ -1,3 +1,3 @@
-import { IProps } from './propsType';
-declare const Input: (props: IProps) => import("react/jsx-runtime").JSX.Element;
+import { Props } from './propsType';
+declare const Input: (props: Props) => import("react/jsx-runtime").JSX.Element;
 export default Input;

package/lib/ProForm/components/base/Input/propsType.d.ts

@@ -1,7 +1,7 @@
 import { InputProps } from 'antd';
 import { FormInstance } from 'antd/es/form/Form';
-import { ProFormOtherProps } from '../../../propsType';
-export interface ProFieldProps<T = any> {
+import { ProFormOtherType } from '../../../propsType';
+export interface ProFieldType<T = any> {
     from?: FormInstance<T>;
     label?: string;
     name?: string;
@@ -9,9 +9,13 @@ export interface ProFieldProps<T = any> {
     fieldName?: string;
     placeholder?: string;
 }
-export interface IProps extends InputProps, ProFieldProps {
-    otherProps?: ProFormOtherProps;
+export interface Props extends InputProps, ProFieldType {
+    otherProps?: ProFormOtherType;
     isView?: boolean;
     /** 脱敏数据位置下标 */
     desensitization?: [number, number];
 }
+/**
+ * 兼容旧命名导出
+ */
+export type ProFieldProps<T = any> = ProFieldType<T>;

package/lib/ProForm/components/base/InputNumber/index.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 import { InputNumberProps } from 'antd';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends Omit<InputNumberProps, 'onBlur'> {
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     range?: string;
     onBlur?: (value?: number, record?: any, object?: any) => void;
     isView?: boolean;

package/lib/ProForm/components/base/Radio/index.d.ts

@@ -1,6 +1,6 @@
 import { RadioChangeEvent, RadioProps } from 'antd';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends Omit<RadioProps, 'options' | 'onChange'> {
     dataSource: any[];
     onChange: (value: any, e: RadioChangeEvent) => void;
@@ -8,7 +8,7 @@ export interface Props extends Omit<RadioProps, 'options' | 'onChange'> {
         label: string;
         value: string;
     };
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const Radio: React.FC<Props>;

package/lib/ProForm/components/base/RangePicker/index.d.ts

@@ -1,9 +1,9 @@
 import type { RangePickerProps } from 'antd/es/date-picker';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 import { Props as RangeProps } from './useDateRange';
 export type Props = {
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     separator?: any;
     showTime?: any;
     isView?: boolean;

package/lib/ProForm/components/base/Select/index.d.ts

@@ -1,10 +1,10 @@
 import { SelectProps } from 'antd';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends SelectProps {
     dataSource?: any[];
     scrollFollowParent?: boolean;
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const Select: React.FC<Props>;

package/lib/ProForm/components/base/Switch/index.d.ts

@@ -1,9 +1,9 @@
 import { SwitchProps } from 'antd';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends Omit<SwitchProps, 'value'> {
     value: any;
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const Switch: React.FC<Props>;