@zat-design/sisyphus-react 3.11.14 → 3.12.0

package/es/ProForm/propsType.d.ts

@@ -4,27 +4,27 @@ import { NamePath } from 'antd/es/form/interface';
 import { StoreValue, Store } from 'rc-field-form/es/interface.d';
 import { ShouldUpdate } from 'rc-field-form/es/Field.d';
 import React, { ReactNode } from 'react';
-import { ComponentMap, ProColumnProps, ViewType } from './components/render/propsType';
-export * from './components/render/propsType';
-export interface ButtonItem extends ButtonProps {
+import type { ProFormColumnType, ViewType } from './components/render/propsType';
+import type { ProFormComponentType } from './components/index.d';
+export interface ButtonType extends ButtonProps {
     children?: any;
 }
-export interface FooterButtonProps {
-    okButtonProps?: ButtonItem;
-    cancelButtonProps?: ButtonItem;
+export interface FooterButtonType {
+    okButtonProps?: ButtonType;
+    cancelButtonProps?: ButtonType;
 }
-export interface ProFormItemChildProps {
+export interface ProFormItemChildType {
     value?: any;
     onChange?: () => void;
     [key: string]: any;
 }
 export type ModeEnum = 'search' | 'drawer';
 type FooterType = ReactNode | {
-    okButtonProps: ButtonItem;
-    cancelButtonProps: ButtonItem;
+    okButtonProps: ButtonType;
+    cancelButtonProps: ButtonType;
 } | boolean;
 export declare const otherKeys: string[];
-export interface ProFormOtherProps {
+export interface ProFormOtherType {
     isView?: boolean;
     viewEmpty?: React.ReactNode;
     label?: React.ReactNode;
@@ -33,7 +33,7 @@ export interface ProFormOtherProps {
     name?: NamePath;
     names?: NamePath[];
     form?: FormInstance;
-    type?: ComponentMap;
+    type?: ProFormComponentType;
     hiddenNames?: string[] | any[];
     colProps: ColProps;
     disabled: boolean;
@@ -45,10 +45,10 @@ export interface ProFormOtherProps {
     globalControl?: boolean;
     formDisabled?: boolean;
     isDiffChange?: boolean;
-    diffConfig?: DiffConfigProps;
+    diffConfig?: DiffConfigType;
     desensitizationKey?: string;
 }
-export interface DiffConfigProps<Values = any> {
+export interface DiffConfigType<Values = any> {
     /** 比对原始数据源 */
     originalValues: Values;
     /** 是否显示对比值气泡 */
@@ -60,7 +60,7 @@ export interface DiffConfigProps<Values = any> {
     /** 是否跟随父组件滚动 */
     scrollFollowParent?: string;
 }
-export interface ProFormProps<Values = any> extends FormProps<Values> {
+export interface ProFormType<Values = any> extends FormProps<Values> {
     disabled?: boolean;
     /** 全局控制优先 */
     globalControl?: boolean;
@@ -69,7 +69,7 @@ export interface ProFormProps<Values = any> extends FormProps<Values> {
     /** 是否查看 */
     isView?: boolean;
     span?: number;
-    columns?: ProColumnProps<Values>[];
+    columns?: ProFormColumnType<Values>[];
     rowProps?: RowProps;
     footer?: FooterType;
     expand?: boolean | number;
@@ -89,7 +89,7 @@ export interface ProFormProps<Values = any> extends FormProps<Values> {
     formId?: string;
     required?: boolean | boolean[];
     /** 表单比对配置 */
-    diffConfig?: DiffConfigProps;
+    diffConfig?: DiffConfigType;
     scrollToError?: boolean;
     /** 性能模式，谨慎使用，默认不开启
      * 1. 开启不过滤names的中间态值
@@ -98,9 +98,18 @@ export interface ProFormProps<Values = any> extends FormProps<Values> {
     /** 全局脱敏开关的key、默认 zat-design-pro-component-desensitization */
     desensitizationKey?: string;
 }
-export interface Transform<T = any> {
+export interface TransformType<T = any> {
     normalize?: (value: StoreValue, prevValue: StoreValue, allValues: Store) => StoreValue;
     getValueProps?: (value: StoreValue) => Record<string, unknown>;
     shouldUpdate?: ShouldUpdate<T>;
 }
 export type DistributiveOmit<T, K extends keyof any> = T extends any ? Omit<T, K> : never;
+/**
+ * 兼容旧命名导出
+ */
+export type FooterButtonProps = FooterButtonType;
+export type ProFormOtherProps = ProFormOtherType;
+export type DiffConfigProps = DiffConfigType;
+export type Transform = TransformType;
+export type { ProFormColumnType } from './components/render/propsType';
+export type { ProColumnProps } from './components/render/propsType';

package/es/ProForm/propsType.js

@@ -1,2 +1 @@
-export * from './components/render/propsType';
 export var otherKeys = ['isView', 'viewEmpty', 'label', 'valueType', 'viewType', 'name', 'names', 'form', 'type', 'hiddenNames'];

package/es/ProForm/utils/transformValue.d.ts

@@ -1,6 +1,6 @@
 import { FormInstance, FormItemProps } from 'antd';
 import { NamePath } from 'antd/es/form/interface';
 import { StoreValue, Store } from 'rc-field-form/es/interface.d';
-import { Transform } from '../propsType';
-export declare const transformValue: (names: NamePath[], form: FormInstance, fieldName: NamePath, normalize?: (value: StoreValue, prevValue: StoreValue, allValues: Store) => StoreValue, getValueProps?: FormItemProps['getValueProps']) => Transform;
+import type { TransformType } from '../propsType';
+export declare const transformValue: (names: NamePath[], form: FormInstance, fieldName: NamePath, normalize?: (value: StoreValue, prevValue: StoreValue, allValues: Store) => StoreValue, getValueProps?: FormItemProps['getValueProps']) => TransformType;
 export default transformValue;

package/es/ProForm/utils/useFieldProps.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
-import { ProFormOtherProps } from '../propsType';
-export declare const FieldProvider: React.Provider<ProFormOtherProps>;
-export declare const useFieldProps: () => ProFormOtherProps;
+import type { ProFormOtherType } from '../propsType';
+export declare const FieldProvider: React.Provider<ProFormOtherType>;
+export declare const useFieldProps: () => ProFormOtherType;

package/es/ProForm/utils/useForm.d.ts

@@ -13,4 +13,4 @@ export interface FormInstanceOption {
     optimize?: boolean;
     formKey?: string;
 }
-export declare const useForm: <T>(originForm?: FormInstanceOption | ModifiedFormInstance<T>, options?: FormInstanceOption) => [ModifiedFormInstance<T>];
+export declare const useForm: <T>(originForm?: ModifiedFormInstance<T> | FormInstanceOption, options?: FormInstanceOption) => [ModifiedFormInstance<T>];

package/es/ProForm/utils/useRules.d.ts

@@ -1,5 +1,5 @@
 import type { InternalNamePath } from 'antd/lib/form/interface';
-import type { ProRule } from '../propsType';
+import type { ProRule } from '../components/render/propsType';
 interface Props {
     rules?: ProRule[];
     required?: boolean;

package/es/ProForm/utils/useShouldUpdate.d.ts

@@ -1,5 +1,5 @@
 import { FormInstance, FormItemProps } from 'antd';
-import { ProColumnProps, ProRule } from '../components/render/propsType';
+import type { ProFormColumnType, ProRule } from '../components/render/propsType';
 interface Result<Values> {
     shouldUpdate?: FormItemProps<Values>['shouldUpdate'];
     show?: boolean;
@@ -9,8 +9,8 @@ interface Result<Values> {
     [key: string]: any;
 }
 interface UseShouldUpdateProps<Values> {
-    show?: ProColumnProps['show'];
-    formItemProps?: ProColumnProps['formItemProps'] & {
+    show?: ProFormColumnType['show'];
+    formItemProps?: ProFormColumnType['formItemProps'] & {
         clearNotShow?: boolean;
         names?: any[];
     };

package/es/ProIcon/index.d.ts

@@ -1,5 +1,5 @@
 import { FC } from 'react';
-import { ProIconProps } from './propsTypes';
+import type { ProIconType } from './propsTypes';
 import './symbolIcon.js';
-declare const ProIcon: FC<ProIconProps>;
+declare const ProIcon: FC<ProIconType>;
 export default ProIcon;

package/es/ProIcon/propsTypes.d.ts

@@ -1,105 +1,176 @@
-import React, { CSSProperties } from 'react';
+import { CSSProperties, ReactNode, MouseEventHandler } from 'react';
 import { ButtonProps } from 'antd/lib/button';
-export type ModeType = 'icon' | 'button';
-interface iconMap {
+/**
+ * 图标模式
+ * @description 定义图标的显示模式：纯图标或按钮形式
+ */
+export type ProIconModeType = 'icon' | 'button';
+/**
+ * 图标映射对象
+ */
+interface ProIconMapType {
+    /**
+     * 图标类型
+     * @description 唯一标识图标的类型名称
+     * @default undefined
+     */
     type: string;
+    /**
+     * 中文显示文本
+     * @description 图标对应的中文描述
+     * @default undefined
+     */
     'text-cn'?: string;
+    /**
+     * 英文显示文本
+     * @description 图标对应的英文描述
+     * @default undefined
+     */
     'text-en'?: string;
 }
-interface themeMap {
+/**
+ * 主题映射对象
+ */
+interface ProIconThemeMapType {
+    /**
+     * 主题颜色映射
+     * @description 不同主题下的颜色值数组
+     * @default undefined
+     */
     [key: string]: string[];
 }
-interface actionMap {
-    themeMap?: themeMap;
-    themeFillMap?: themeMap;
+/**
+ * 操作映射对象
+ */
+interface ProIconActionMapType {
+    /**
+     * 主题颜色映射
+     * @description 不同主题下的颜色映射
+     * @default undefined
+     */
+    themeMap?: ProIconThemeMapType;
+    /**
+     * 主题填充颜色映射
+     * @description 不同主题下的填充颜色映射
+     * @default undefined
+     */
+    themeFillMap?: ProIconThemeMapType;
+    /**
+     * 渐变色值
+     * @description 渐变色值数组
+     * @default undefined
+     */
     gradation?: string[];
+    /**
+     * 填充色值
+     * @description 填充色值数组
+     * @default undefined
+     */
     fill?: string[];
 }
-export interface ProIconProps {
+export interface ProIconType {
     /**
-     * @description        本地import引入
-     * @default            ""
+     * 图标路径
+     * @description 本地import引入的图标路径
+     * @default ""
      */
     src?: string;
     /**
-     * @description       图标的名称
-     * @default           -
+     * 图标名称
+     * @description 图标的类型名称，用于识别特定图标
+     * @default undefined
      */
     type?: string;
     /**
-     * @description       图标的大小,同时设置图标的width以及height
-     * @default           14
+     * 图标大小
+     * @description 图标的大小，同时设置图标的width以及height
+     * @default 14
      */
     size?: number;
     /**
-     * @description       图标旋转角度（IE9 无效）
-     *
-     * @default           -
+     * 旋转角度
+     * @description 图标旋转角度（IE9 无效）
+     * @default undefined
      */
     rotate?: number;
     /**
-     * @description       图标是否旋转loading
-     *
-     * @default           false
+     * 是否旋转
+     * @description 图标是否旋转loading效果
+     * @default false
      */
     spin?: boolean;
     /**
-     * @description       图标的颜色,svg的fill属性
-     *
-     * @default           -
+     * 图标颜色
+     * @description 图标的颜色，设置svg的fill属性
+     * @default undefined
      */
     color?: string;
     /**
-     * @description      禁用
-     * @default           false
+     * 是否禁用
+     * @description 设置图标为禁用状态
+     * @default false
      */
     disabled?: boolean;
     /**
-     * @description      提示
-     * @default           -
+     * 提示信息
+     * @description 鼠标悬停时显示的提示信息
+     * @default undefined
      */
-    tooltip?: string | React.ReactNode;
+    tooltip?: string | ReactNode;
     /**
-     * @description      是否跟随主题色
-     * @default           false
+     * 是否跟随主题
+     * @description 是否跟随系统主题色变化
+     * @default false
      */
     theme?: boolean;
     /**
-     * @description       图标的点击事件
-     * @default           ()=>{}
+     * 点击事件
+     * @description 图标的点击事件处理函数
+     * @default () => {}
      */
-    onClick?: React.MouseEventHandler<SVGSVGElement>;
+    onClick?: MouseEventHandler<SVGSVGElement>;
     /**
-     * @description       图标的className
-     * @default           -
+     * 自定义类名
+     * @description 自定义图标的CSS类名
+     * @default undefined
      */
     className?: string;
     /**
-     * @description       计算后的 svg 元素样式,style的优先级高过size/color/rotate属性
-     * @default           -
+     * 自定义样式
+     * @description 计算后的svg元素样式，优先级高于size/color/rotate属性
+     * @default undefined
      */
     style?: CSSProperties;
     /**
-     * @description       模式
-     * @default           'icon'
+     * 显示模式
+     * @description 图标的显示模式：图标或按钮
+     * @default 'icon'
      */
-    mode?: ModeType;
+    mode?: ProIconModeType;
     /**
-     * @description        mode button时 props 与antd Button接收props一致
-     * @default           'link'
+     * 按钮属性
+     * @description mode为button时的按钮属性，与antd Button接收props一致
+     * @default { type: 'link' }
      */
     buttonProps?: ButtonProps;
     /**
-     * @description        icon与中文映射表
-     * @default            项目内认默映射
+     * 图标映射表
+     * @description 图标与中英文文本的映射表
+     * @default 项目内默认映射
+     */
+    mapList?: ProIconMapType[];
+    /**
+     * SVG操作表
+     * @description SVG变更操作表，用于主题配置
+     * @default undefined
      */
-    mapList?: iconMap[];
+    actionMap?: ProIconActionMapType;
     /**
-     * @description        svg变更操作表 请到 ProThemeTools 主题配置查看示例
-     * @default
+     * 按钮图标标记
+     * @description 内部使用，标记图标作为按钮使用
+     * @default undefined
      */
-    actionMap?: actionMap;
-    /** 内部使用 */
     buttonIcon?: boolean;
 }
+export type ProIconProps = ProIconType;
 export {};

package/es/ProLayout/components/Layout/Header/index.d.ts

@@ -1,4 +1,4 @@
 import type { FC } from 'react';
-import type { ProLayoutProps } from '../../../propTypes';
-declare const Header: FC<ProLayoutProps>;
+import type { ProLayoutType } from '../../../propTypes';
+declare const Header: FC<ProLayoutType>;
 export default Header;

package/es/ProLayout/components/Layout/Menu/index.d.ts

@@ -1,4 +1,4 @@
 import type { FC } from 'react';
-import type { ProLayoutProps } from '../../../propTypes';
-declare const Menu: FC<ProLayoutProps>;
+import type { ProLayoutType } from '../../../propTypes';
+declare const Menu: FC<ProLayoutType>;
 export default Menu;

package/es/ProLayout/components/Layout/Notice/index.d.ts

@@ -1,4 +1,4 @@
 import type { FC } from 'react';
-import type { ProLayoutProps } from '../../../propTypes';
-declare const Notice: FC<ProLayoutProps>;
+import type { ProLayoutType } from '../../../propTypes';
+declare const Notice: FC<ProLayoutType>;
 export default Notice;

package/es/ProLayout/components/ProCollapse/PropTypes.d.ts

@@ -1,7 +1,7 @@
 import React, { CSSProperties } from 'react';
 import { CollapseProps, CollapsePanelProps } from 'antd/es/collapse';
 export type levelType = '1' | '2';
-export interface TitleListProps {
+export interface TitleListType {
     /**
     * @description       描述的标题
     * @default           -
@@ -13,7 +13,7 @@ export interface TitleListProps {
     */
     value: string | number | undefined | React.ReactNode;
 }
-export interface ProCollapseProps {
+export interface ProCollapseType {
     /**
     * @description       折叠头部标题
     * @default           -
@@ -75,6 +75,11 @@ export interface ProCollapseProps {
    */
     folding?: boolean;
     /**
+   * @description      控制折叠面板展开状态
+   * @default           -
+   */
+    open?: boolean;
+    /**
   * @description      antd Collapse属性
   * @default           -
   */
@@ -86,3 +91,5 @@ export interface ProCollapseProps {
     collapsePanelProps?: CollapsePanelProps;
     [key: string]: any;
 }
+export type ProCollapseProps = ProCollapseType;
+export type TitleListProps = TitleListType;

package/es/ProLayout/components/ProCollapse/index.d.ts

@@ -1,3 +1,3 @@
-import { ProCollapseProps } from './PropTypes';
-declare const ProCollapse: (props: ProCollapseProps) => import("react/jsx-runtime").JSX.Element;
+import type { ProCollapseType } from './PropTypes';
+declare const ProCollapse: (props: ProCollapseType) => import("react/jsx-runtime").JSX.Element;
 export default ProCollapse;

package/es/ProLayout/components/ProCollapse/index.js

@@ -2,8 +2,8 @@ import "antd/es/descriptions/style";
 import _Descriptions from "antd/es/descriptions";
 import "antd/es/space/style";
 import _Space from "antd/es/space";
-import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
 import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
 import "antd/es/collapse/style";
 import _Collapse from "antd/es/collapse";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
@@ -31,13 +31,21 @@ var ProCollapse = function ProCollapse(props) {
     style = props.style,
     _props$folding = props.folding,
     folding = _props$folding === void 0 ? false : _props$folding,
-    collapseProps = props.collapseProps,
+    _props$collapseProps = props.collapseProps,
+    collapseProps = _props$collapseProps === void 0 ? {} : _props$collapseProps,
     collapsePanelProps = props.collapsePanelProps,
     className = props.className,
     icon = props.icon,
     _props$autoHeight = props.autoHeight,
     autoHeight = _props$autoHeight === void 0 ? true : _props$autoHeight,
-    onChange = props.onChange;
+    onChange = props.onChange,
+    open = props.open;
+  // 当同时设置了open和collapseProps.activeKey时，以collapseProps.activeKey为准
+  // 这样保证了与已有代码的兼容性，并提供了更简便的控制面板展开状态的方式
+  var finalCollapseProps = _objectSpread({}, collapseProps);
+  if (open !== undefined && !('activeKey' in finalCollapseProps)) {
+    finalCollapseProps.activeKey = open ? ['1'] : [];
+  }
   var cls = classNames(_defineProperty({
     'pro-collapse': true,
     'pro-collapse-level2': level === '2',
@@ -157,7 +165,7 @@ var ProCollapse = function ProCollapse(props) {
       expandIconPosition: "end",
       defaultActiveKey: folding ? [] : ['1'],
       onChange: onChange
-    }, collapseProps), {}, {
+    }, finalCollapseProps), {}, {
       children: renderPanel()
     }))
   });

package/es/ProLayout/components/ProFooter/PropTypes.d.ts

@@ -2,10 +2,27 @@ export interface stateProps {
     width?: number;
     [key: string]: any;
 }
-export interface ProFooterProps {
+export interface ProFooterType {
+    /**
+     * @description 是否显示
+     * @default true
+     */
     visible?: boolean;
+    /**
+     * @description 层级
+     * @default 99
+     */
     zIndex?: number;
+    /**
+     * @description 侧边栏选择器
+     * @default '.pro-layout-sider-nav'
+     */
     sideDom?: string;
+    /**
+     * @description 内容选择器
+     * @default '.pro-layout-content'
+     */
     contentDom?: string;
     [key: string]: any;
 }
+export type ProFooterProps = ProFooterType;

package/es/ProLayout/components/ProFooter/index.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="react" />
-import { ProFooterProps } from './PropTypes';
-declare const _default: import("react").MemoExoticComponent<(props: ProFooterProps) => import("react/jsx-runtime").JSX.Element>;
+import type { ProFooterType } from './PropTypes';
+declare const _default: import("react").MemoExoticComponent<(props: ProFooterType) => import("react/jsx-runtime").JSX.Element>;
 export default _default;