@zat-design/sisyphus-react 3.11.14 → 3.12.0-beta.1

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

@@ -2,70 +2,165 @@ import React from 'react';
 import type { ModalProps } from 'antd';
 export type BreadcrumbType = 'breadcrumb' | 'copy' | 'info' | 'version' | 'tag';
 export type NavType = 'money' | 'thousandth' | 'enumName' | 'enumCodeName' | 'date' | 'dateTime';
-export interface BreadcrumbColumnsProps {
+export interface BreadcrumbColumnType {
+    /**
+     * @description 类型
+     * @default -
+     */
     type?: BreadcrumbType;
+    /**
+     * @description 值类型
+     * @default -
+     */
     valueType?: BreadcrumbType;
+    /**
+     * @description 值
+     * @default -
+     */
     value: any;
+    /**
+     * @description 宽度
+     * @default -
+     */
     width?: string | number;
+    /**
+     * @description 是否显示
+     * @default -
+     */
     show?: boolean;
+    /**
+     * @description 标签
+     * @default -
+     */
     tag?: string | React.ReactNode | (string | React.ReactNode)[];
 }
-export interface SubDescribeColumnsProps {
-    label: string | React.ReactNode;
+export interface SubDescribeColumnType {
+    /**
+     * @description 描述内容
+     * @default -
+     */
+    label?: string | React.ReactNode;
+    /**
+     * @description 类型
+     * @default -
+     */
     type?: NavType;
+    /**
+     * @description 值类型
+     * @default -
+     */
     valueType?: NavType;
+    /**
+     * @description 精度
+     * @default -
+     */
     precision?: number;
-    value: any;
+    /**
+     * @description 值
+     * @default -
+     */
+    value?: any;
+    /**
+     * @description 是否显示
+     * @default -
+     */
     show?: boolean;
+    /**
+     * @description 枚举代码
+     * @default -
+     */
     code?: string;
 }
-export interface DescribeColumnsProps {
+export interface DescribeColumnType {
+    /**
+     * @description 描述内容
+     * @default -
+     */
     label?: string | React.ReactNode;
+    /**
+     * @description 是否显示
+     * @default -
+     */
     copyable?: boolean;
+    /**
+     * @description 值
+     * @default -
+     */
     value?: string | React.ReactNode;
+    /**
+     * @description 是否显示
+     * @default -
+     */
     show?: boolean;
+    /**
+     * @description 链接
+     * @default -
+     */
     link?: string;
-    tag?: string | React.ReactNode | (string | React.ReactNode)[];
-    width?: string | number;
-    /** 多值配置 */
+    /**
+     * @description 多值配置
+     * @default -
+     */
     items?: {
         copyable?: boolean;
         value: string | React.ReactNode;
         link?: string;
         tag?: string | React.ReactNode | (string | React.ReactNode)[];
     }[];
+    /**
+     * @description 宽度
+     * @default -
+     */
+    width?: string | number;
+    /**
+     * @description 标签
+     * @default -
+     */
+    tag?: string | React.ReactNode | (string | React.ReactNode)[];
 }
-export interface ProHeaderProps {
+export interface ProHeaderType {
+    /**
+     * @description 标题
+     * @default -
+     */
     title?: string | React.ReactNode;
     /**
      * @description       面包屑配置数据
      * @deprecated        将于下个版本 4.0.0 被弃用
      * @default           -
      */
-    breadcrumbList?: BreadcrumbColumnsProps[];
+    breadcrumbList?: BreadcrumbColumnType[];
     /**
    * @description      面包屑配置数据
    * @default           -
    */
-    breadcrumbColumns?: BreadcrumbColumnsProps[];
+    breadcrumbColumns?: BreadcrumbColumnType[];
+    /**
+     * @description 是否隐藏溢出
+     * @default -
+     */
     bodyOverFlowHidden?: boolean;
+    /**
+     * @description 操作渲染
+     * @default -
+     */
     actionRender?: React.ReactNode | React.ReactNode[];
     /**
     * @description      次级描述数据源配置
     * @deprecated        将于下个版本 4.0.0 被弃用
     * @default           -
     */
-    describeList?: SubDescribeColumnsProps[];
+    describeList?: SubDescribeColumnType[];
     /**
     * @description      主要描述数据源配置
     * @default           -
     */
-    describeColumns?: DescribeColumnsProps[];
+    describeColumns?: DescribeColumnType[];
     /**
     * @description      次级描述数据源配置
     * @default           -
     */
-    subDescribeColumns?: SubDescribeColumnsProps[];
+    subDescribeColumns?: SubDescribeColumnType[];
     /**
     * @description      次级描述是否展开
     * @default           -
@@ -97,7 +192,19 @@ export interface ProHeaderProps {
     * @default           -
     */
     isConfirmBackModalProps?: ModalProps;
+    /**
+     * @description      层级
+     * @default           -
+     */
     zIndex?: number;
+    /**
+     * @description      返回
+     * @default           100
+     */
     onBack?: () => void;
     [key: string]: any;
 }
+export type ProHeaderProps = ProHeaderType;
+export type BreadcrumbColumnsProps = BreadcrumbColumnType;
+export type SubDescribeColumnsProps = SubDescribeColumnType;
+export type DescribeColumnsProps = DescribeColumnType;

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

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

package/es/ProLayout/index.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="react" />
-import type { ProLayoutProps } from './propTypes';
+import type { ProLayoutType } from './propTypes';
 export declare const LayoutContext: import("react").Context<{
     selectedPath: string;
     onSelected: (params: any) => void;
     target: '_blank' | '_parent' | '_self' | '_top';
 }>;
 declare const ProLayout: {
-    (props: ProLayoutProps): import("react/jsx-runtime").JSX.Element;
+    (props: ProLayoutType): import("react/jsx-runtime").JSX.Element;
     defaultProps: {
         menus: any[];
         iconfontUrl: string;
@@ -18,8 +18,8 @@ declare const ProLayout: {
         headerHeight: number;
         contentStyle: {};
     };
-    ProCollapse: (props: import("./components/ProCollapse/PropTypes").ProCollapseProps) => import("react/jsx-runtime").JSX.Element;
-    ProFooter: import("react").MemoExoticComponent<(props: import("./components/ProFooter/PropTypes").ProFooterProps) => import("react/jsx-runtime").JSX.Element>;
-    ProHeader: import("react").MemoExoticComponent<(props: import("./components/ProHeader/PropTypes").ProHeaderProps) => import("react/jsx-runtime").JSX.Element>;
+    ProCollapse: (props: import("./components/ProCollapse/PropTypes").ProCollapseType) => import("react/jsx-runtime").JSX.Element;
+    ProFooter: import("react").MemoExoticComponent<(props: import("./components/ProFooter/PropTypes").ProFooterType) => import("react/jsx-runtime").JSX.Element>;
+    ProHeader: import("react").MemoExoticComponent<(props: import("../index").ProHeaderType) => import("react/jsx-runtime").JSX.Element>;
 };
 export default ProLayout;

package/es/ProLayout/index.js

@@ -56,8 +56,10 @@ var ProLayout = function ProLayout(props) {
       return _message.warning('Warning: Missing menu data source, or menu data source is not an array');
     }
     var userData = transformMenus(dataSource, pathPrefix);
+    // 确保 menus 始终是一个数组
+    var menuData = Array.isArray(userData) ? userData : (userData === null || userData === void 0 ? void 0 : userData.menus) || [];
     setState({
-      menus: userData
+      menus: menuData
     });
   }, [dataSource]);
   /**
@@ -88,7 +90,9 @@ var ProLayout = function ProLayout(props) {
     })), _jsxs("div", {
       className: contentCls,
       children: [_jsx(Menu, _objectSpread(_objectSpread({}, props), {}, {
-        dataSource: menus,
+        dataSource: Array.isArray(menus) ? {
+          menus: menus
+        } : menus,
         notice: notice,
         collapsed: collapsed,
         onToggle: function onToggle() {

package/es/ProLayout/propTypes.d.ts

@@ -1,76 +1,233 @@
 import { CSSProperties, ReactNode } from 'react';
 import { ProWaterMarkProps } from '../ProWaterMark/propsType';
-export interface MenusProps {
+export interface MenusType {
+    /**
+     * @description 菜单ID
+     * @default -
+     */
     id?: number;
+    /**
+     * @description 菜单唯一code
+     * @default -
+     */
     code?: string;
+    /**
+     * @description 菜单名称
+     * @default -
+     */
     name?: string;
+    /**
+     * @description 菜单路由
+     * @default -
+     */
     url?: string;
+    /**
+     * @description 点击路由时，重定向地址
+     * @default -
+     */
     redirectUrl?: string;
+    /**
+     * @description 关联的上级id
+     * @default -
+     */
     parentId?: number | null;
+    /**
+     * @description 备注
+     * @default -
+     */
     description?: any;
+    /**
+     * @description 扩展备用字段
+     * @default -
+     */
     extraInfo?: any;
+    /**
+     * @description 排序
+     * @default -
+     */
     sort?: number | undefined | null;
+    /**
+     * @description 是否隐藏菜单
+     * @default false
+     */
     hideInMenu?: boolean;
+    /**
+     * @description iconfont图标
+     * @default -
+     */
     icon?: string;
+    /**
+     * @description 图片icon
+     * @default -
+     */
     imgUrl?: string;
-    imgActiveUrl?: string;
+    /**
+     * @description 菜单类型
+     * @default -
+     */
     type?: string;
-    keyUrlPath?: string[];
-    keyIdPath?: number[];
-    children?: MenusProps[] | null;
+    /**
+     * @description 允许扩展字段
+     */
     [key: string]: any;
 }
-export interface DataSourceProps {
+export interface DataSourceType {
+    /**
+     * @description 用户信息
+     * @default -
+     */
     userInfo?: any;
-    menus?: MenusProps[];
+    /**
+     * @description 处理后一级菜单详情
+     * @default []
+     */
+    menus?: MenusType[];
 }
+/**
+ * @description 主题枚举类型
+ */
 type themeEnum = 'light' | 'dark';
+/**
+ * @description 是否带有菜单界面的配置
+ */
 type pureKey = boolean | {
     topMenu?: boolean;
     leftMenu?: boolean;
 };
-export interface ProLayoutProps {
+export interface ProLayoutType {
+    /**
+     * @description 左侧logo
+     * @default -
+     */
     logo?: ReactNode | string;
+    /**
+     * @description 类名
+     * @default ""
+     */
     className?: string;
+    /**
+     * @description iconfontUrl
+     * @default -
+     */
     iconfontUrl?: string;
+    /**
+     * @description 右侧内容渲染
+     * @default -
+     */
     rightContentRender?: ReactNode;
+    /**
+     * @description 头部内容渲染
+     * @default -
+     */
     headerContentRender?: ReactNode;
-    headerTitleRender?: ReactNode;
-    sideMenuHeaderRender?: ReactNode;
+    /**
+     * @description 侧边栏底部渲染
+     * @default -
+     */
     sideMenuFooterRender?: ReactNode;
+    /**
+     * @description 通告
+     * @default -
+     */
     headerNotice?: ReactNode | string;
+    /**
+     * @description 通告
+     * @default -
+     */
     notice?: ReactNode | string;
+    /**
+     * @description 标题
+     * @default -
+     */
     title?: string;
-    dataSource?: DataSourceProps | Partial<MenusProps>;
+    /**
+     * @description 数据源
+     * @default -
+     */
+    dataSource?: DataSourceType | Partial<MenusType>;
+    /**
+     * @description 是否折叠
+     * @default false
+     */
     collapsed?: boolean;
     /**
-  *  菜单拼接前缀
-  */
+     * @description 菜单拼接路径前缀
+     * @default ""
+     */
     pathPrefix?: string;
     /**
-    *  是否带有菜单界面，true不带，只显示content内容
-    */
+     * @description 是否带有菜单界面，true不带，只显示content内容
+     * @default false
+     */
     pure?: pureKey;
+    /**
+     * @description 头部区域高度
+     * @default 48
+     */
     headerHeight?: number;
+    /**
+     * @description 内容区域样式
+     * @default {}
+     */
     contentStyle?: CSSProperties;
+    /**
+     * @description 水印配置
+     * @default {}
+     */
     waterMarkProps?: ProWaterMarkProps;
-    theme?: themeEnum;
     /**
-  *  折叠回调事件
-  */
-    onCollapsedChange?: (collapsed: any) => void;
-    /** 规定在何处打开被链接文档
-     *  _blank
-     *  _parent
-     *  _self
-     *  _top
+     * @description 折叠回调事件
+     * @default -
+     */
+    onCollapsedChange?: (collapsed: boolean) => void;
+    /**
+     * @description 规定在何处打开被链接文档
+     * @default "_self"
      */
     target?: '_blank' | '_parent' | '_self' | '_top';
+    /**
+     * @description 主题
+     * @default "light"
+     */
+    theme?: themeEnum;
+    /**
+     * @description 子元素
+     * @default -
+     */
+    children?: ReactNode;
+    /**
+     * @description 允许扩展字段
+     */
     [key: string]: any;
 }
-export interface ProLayoutStates {
+export interface ProLayoutStatesType {
+    /**
+     * @description 是否折叠
+     * @default false
+     */
     collapsed?: boolean;
+    /**
+     * @description 通告
+     * @default -
+     */
     notice?: ReactNode | string;
+    /**
+     * @description 菜单列表
+     * @default []
+     */
+    menus?: MenusType[];
+    /**
+     * @description 选中的路径
+     * @default ""
+     */
+    selectedPath?: string;
+    /**
+     * @description 允许扩展字段
+     */
     [key: string]: any;
 }
+export type MenusProps = MenusType;
+export type DataSourceProps = DataSourceType;
+export type ProLayoutProps = ProLayoutType;
+export type ProLayoutStates = ProLayoutStatesType;
 export {};

package/es/ProLayout/utils/index.d.ts

@@ -1,4 +1,4 @@
-import type { MenusProps } from '../propTypes';
+import type { MenusType } from '../propTypes';
 /**
  * 通过URL获取对应keyIdPath
  * @param menus  菜单数据
@@ -17,7 +17,7 @@ export declare const transformMenu: (menuData: any[], pathPrefix: string) => any
  * @param data 菜单数据源
  * @returns []
  */
-export declare const transformMenus: (data: MenusProps, pathPrefix: string) => any[] | MenusProps;
+export declare const transformMenus: (data: MenusType, pathPrefix: string) => any[] | MenusType;
 /**
  * 获取URL中的search参数
  * @param name 参数key

package/es/ProSelect/index.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { PropSelectProps, ProSelectAction } from './propsType';
+import type { PropSelectType, ProSelectActionType } from './propsType';
 import './index.less';
-export declare const ProSelect: (props: PropSelectProps, ref: React.Ref<ProSelectAction> | undefined) => import("react/jsx-runtime").JSX.Element;
-declare const _default: React.ForwardRefExoticComponent<PropSelectProps & React.RefAttributes<ProSelectAction>>;
+export declare const ProSelect: (props: PropSelectType, ref: React.Ref<ProSelectActionType> | undefined) => import("react/jsx-runtime").JSX.Element;
+declare const _default: React.ForwardRefExoticComponent<PropSelectType & React.RefAttributes<ProSelectActionType>>;
 export default _default;