@zat-design/sisyphus-react 3.11.14 → 3.12.0

package/lib/ProSelect/propsType.d.ts

@@ -1,66 +1,176 @@
 import { ReactNode } from 'react';
 import type { SelectProps } from 'antd';
 import { Service, Options, Result } from 'ahooks/lib/useRequest/src/types';
-import { ProFormOtherProps } from '../ProForm/propsType';
-export interface DataOption {
+import type { ProFormOtherType } from '../ProForm/propsType';
+/**
+ * @description 数据选项类型
+ */
+export interface DataOptionType {
+    /**
+     * @description 展示标签
+     * @default -
+     */
     label?: string;
+    /**
+     * @description 选项值
+     * @default -
+     */
     value?: string | number;
+    /**
+     * @description 允许扩展字段
+     */
     [key: string]: any;
 }
-export interface PropSelectProps extends Omit<SelectProps, 'onSearch'> {
-    /** 是否查看模式 */
+/**
+ * @description 选择框属性类型
+ */
+export interface PropSelectType extends Omit<SelectProps, 'onSearch'> {
+    /**
+     * @description 是否查看模式
+     * @default false
+     */
     isView?: boolean;
-    /** 是否开启组件在可视区域中才发起useRequest请求 默认 false */
+    /**
+     * @description 是否开启组件在可视区域中才发起useRequest请求
+     * @default false
+     */
     viewportReady?: boolean;
-    /** 默认数组第一项 */
+    /**
+     * @description 默认数组第一项
+     * @default false
+     */
     defaultOne?: boolean;
-    /** 数据源 */
-    dataSource?: DataOption[];
-    /** list场景中过滤掉已选择的值 */
+    /**
+     * @description 数据源
+     * @default -
+     */
+    dataSource?: DataOptionType[];
+    /**
+     * @description list场景中过滤掉已选择的值
+     * @default false
+     */
     filterInList?: boolean;
-    /** @deprecated  兼容 2.0 版本、3.0 使用view 模式 */
+    /**
+     * @deprecated 兼容 2.0 版本、3.0 使用view 模式
+     * @default -
+     */
     defaultDisableValue?: string;
-    /** 是否展示 tooltip、当 label 特别长的时候使用 */
+    /**
+     * @description 是否展示 tooltip、当 label 特别长的时候使用
+     * @default false
+     */
     tooltip?: boolean;
-    /** 是否展示 code-label 形式 */
+    /**
+     * @description 是否展示 code-label 形式
+     * @default false
+     */
     showCodeName?: boolean;
-    /** 集成表单 form 的属性 */
-    otherProps?: ProFormOtherProps;
-    /** 下拉框滚动是否跟随父级 */
+    /**
+     * @description 集成表单 form 的属性
+     * @default -
+     */
+    otherProps?: ProFormOtherType;
+    /**
+     * @description 下拉框滚动是否跟随父级
+     * @default false
+     */
     scrollFollowParent?: boolean;
-    /** 远程请求接口 */
+    /**
+     * @description 远程请求接口
+     * @default -
+     */
     useRequest?: {
+        /**
+         * @description 请求服务函数
+         */
         service?: Service<any, any>;
+        /**
+         * @description 请求选项
+         */
         options?: Options<any, any>;
     };
     /**
      * @deprecated 兼容 2.0 版本、3.0 使用 transformResponse
-     * @param data
-     * @param setSelectList
+     * @param data 数据
+     * @param setSelectList 设置选择列表的函数
      * @returns
      */
     updateDataSource?: (data: any, setSelectList: any) => void;
-    /** 格式化数据 */
-    transformResponse?: (data: any) => DataOption[];
-    /** 点击搜索执行 */
+    /**
+     * @description 格式化数据
+     * @param data 后台返回的数据
+     * @returns 格式化后的数据选项
+     */
+    transformResponse?: (data: any) => DataOptionType[];
+    /**
+     * @description 点击搜索执行
+     * @param value 搜索值
+     * @param useRequest 请求实例
+     */
     onSearch?: (value: string, useRequest: Result<any, any>) => void;
-    /** 自定义展示 */
-    optionRender?: (value: DataOption) => string | ReactNode;
-    /** 用来转换修改value值 和 getValueProps配合使用  */
-    getChangeValue?: (value: DataOption) => any;
-    /** 用来转换传入的value值 getChangeValue配合使用 */
-    getValueProps?: (value: DataOption) => any;
+    /**
+     * @description 自定义展示
+     * @param value 数据选项
+     * @returns 自定义渲染内容
+     */
+    optionRender?: (value: DataOptionType) => string | ReactNode;
+    /**
+     * @description 用来转换修改value值 和 getValueProps配合使用
+     * @param value 数据选项
+     * @returns 转换后的值
+     */
+    getChangeValue?: (value: DataOptionType) => any;
+    /**
+     * @description 用来转换传入的value值 getChangeValue配合使用
+     * @param value 数据选项
+     * @returns 转换后的值属性
+     */
+    getValueProps?: (value: DataOptionType) => any;
 }
-export interface ProSelectAction {
-    /** 实例方法、根据 code ｜ code[] 批量获取数据 */
+/**
+ * @description ProSelect操作接口类型
+ */
+export interface ProSelectActionType {
+    /**
+     * @description 实例方法、根据 code ｜ code[] 批量获取数据
+     * @param code 代码或代码数组
+     * @param key 可选键名
+     * @returns 获取的数据
+     */
     getValueObject: (code: string | string[], key?: string) => any;
-    /** 获取发生请求的 useRequest 的 ref */
+    /**
+     * @description 获取发生请求的 useRequest 的 ref
+     */
     useRequestRef: Result<any, any>;
 }
-export interface ResponseData {
+/**
+ * @description 响应数据接口类型
+ */
+export interface ResponseDataType {
+    /**
+     * @description 状态码
+     */
     status: number;
+    /**
+     * @description 消息
+     */
     message: string;
+    /**
+     * @description 数据
+     */
     data: any;
+    /**
+     * @description 是否成功
+     * @default -
+     */
     success?: boolean;
+    /**
+     * @description 代码
+     * @default -
+     */
     code?: number;
 }
+export type DataOption = DataOptionType;
+export type PropSelectProps = PropSelectType;
+export type ProSelectAction = ProSelectActionType;
+export type ResponseData = ResponseDataType;

package/lib/ProStep/components/Anchor/index.d.ts

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

package/lib/ProStep/components/Item/index.d.ts

@@ -1,3 +1,3 @@
-import { ProStepItemPropsType } from '../../propsType';
-declare const ProStepItem: ({ id, title, collapse: collapseItem, children, lazyLoad: stepLazyLoad, ...restProps }: ProStepItemPropsType) => import("react/jsx-runtime").JSX.Element;
+import { ProStepItemType } from '../../propsType';
+declare const ProStepItem: ({ id, title, collapse: collapseItem, children, lazyLoad: stepLazyLoad, order, ...restProps }: ProStepItemType) => JSX.Element;
 export default ProStepItem;

package/lib/ProStep/components/Item/index.js

@@ -14,7 +14,8 @@ var _reactLazyload = _interopRequireWildcard(require("react-lazyload"));
 var _lodash = require("lodash");
 var _index = require("../../index");
 var _ProCollapse = _interopRequireDefault(require("../../../ProLayout/components/ProCollapse"));
-var _excluded = ["id", "title", "collapse", "children", "lazyLoad"];
+var _excluded = ["id", "title", "collapse", "children", "lazyLoad", "order"];
+// 默认的懒加载配置
 var defaultLazyLoadConfig = {
   height: 200,
   offset: 100,
@@ -27,6 +28,8 @@ var ProStepItem = function ProStepItem(_ref) {
     collapseItem = _ref$collapse === void 0 ? true : _ref$collapse,
     children = _ref.children,
     stepLazyLoad = _ref.lazyLoad,
+    _ref$order = _ref.order,
+    order = _ref$order === void 0 ? 0 : _ref$order,
     restProps = (0, _objectWithoutProperties2.default)(_ref, _excluded);
   var _useStep = (0, _index.useStep)(),
     register = _useStep.register,
@@ -39,13 +42,14 @@ var ProStepItem = function ProStepItem(_ref) {
       register === null || register === void 0 ? void 0 : register((0, _objectSpread2.default)({
         id: id,
         title: title,
+        order: order,
         lazyLoad: lazyLoad
       }, restProps));
     }, 0);
     return function () {
       clearTimeout(timeoutId);
     };
-  }, [id, title, lazyLoad, restProps, register]);
+  }, [id, title, order, lazyLoad, restProps, register]);
   var renderChildren = function renderChildren() {
     if (lazyLoad) {
       var lazyLoadProps = (0, _lodash.isBoolean)(lazyLoad) ? defaultLazyLoadConfig : lazyLoad;

package/lib/ProStep/components/Listener/index.d.ts

@@ -1,3 +1,4 @@
-import React from 'react';
-declare const _default: ({ children, delayTime, excludes, ...props }: any) => React.DetailedReactHTMLElement<any, HTMLElement>;
-export default _default;
+import { ReactElement } from 'react';
+import type { ListenerProps } from '../../propsType';
+declare const Listener: ({ children, delayTime, excludes, ...props }: ListenerProps) => ReactElement;
+export default Listener;

package/lib/ProStep/components/Listener/index.js

@@ -15,6 +15,11 @@ var _reactLazyload = require("react-lazyload");
 var _index = require("../../index");
 var _utils = require("../../utils");
 var _excluded = ["children", "delayTime", "excludes"];
+/**
+ * 检查错误列表并返回第一个错误项
+ * @param arr DOM元素数组
+ * @returns 错误元素信息
+ */
 var checkErrorList = function checkErrorList(arr) {
   for (var i = 0; i < arr.length; i++) {
     if (arr[i].className.includes('errored')) {
@@ -26,8 +31,12 @@ var checkErrorList = function checkErrorList(arr) {
   }
   return null;
 };
+/**
+ * 查找第一个错误的DOM元素
+ * @returns 错误元素信息
+ */
 var findFirstErrorDom = function findFirstErrorDom() {
-  var errorList = document.querySelectorAll('.pro-step-com-menu-item') || [];
+  var errorList = document.querySelectorAll('.pro-step-com-menu-item');
   var hasErrorItem = document.querySelectorAll('.pro-step-com-menu-item .errored');
   var hasFormError = document.querySelector('.ant-form-item-explain-error');
   if ((hasErrorItem === null || hasErrorItem === void 0 ? void 0 : hasErrorItem.length) && !hasFormError) {
@@ -35,13 +44,17 @@ var findFirstErrorDom = function findFirstErrorDom() {
   }
   return null;
 };
-// Function to check if all modules are loaded
+/**
+ * 检查所有模块是否已加载完成
+ * @param data 模块加载数据
+ * @returns 是否所有模块都已加载
+ */
 var areAllModulesLoaded = function areAllModulesLoaded(data) {
   return data.every(function (item) {
     return (item === null || item === void 0 ? void 0 : item.loaded) === true;
   });
 };
-var _default = exports.default = function _default(_ref) {
+var Listener = function Listener(_ref) {
   var children = _ref.children,
     delayTime = _ref.delayTime,
     excludes = _ref.excludes,
@@ -95,4 +108,5 @@ var _default = exports.default = function _default(_ref) {
       }, _callee);
     })), 3000)
   }));
-};
+};
+var _default = exports.default = Listener;

package/lib/ProStep/components/Step/index.d.ts

@@ -1,5 +1,5 @@
-import { ProStepPropsType } from '../../propsType';
-export declare const Step: ({ fixedTop, dataSource, activeKey, errorCollection, style, targetOffset, scrollToError, }: ProStepPropsType & {
+import { ProStepType } from '../../propsType';
+export declare const Step: ({ fixedTop, dataSource, activeKey, errorCollection, style, targetOffset, scrollToError, }: import("../../propsType").ProStepPropsType & {
     errorCollection: object;
 }) => import("react/jsx-runtime").JSX.Element;
 export default Step;

package/lib/ProStep/index.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="react" />
-import { ProStepPropsType } from './propsType';
+import { ProStepType, ProStepContextType } from './propsType';
 import './style/index.less';
-export declare const ProStepContext: import("react").Context<any>;
-export declare const useStep: () => any;
+export declare const ProStepContext: import("react").Context<ProStepContextType>;
+export declare const useStep: () => Partial<ProStepContextType>;
 declare const ProStep: {
-    ({ children, ...resetProps }: ProStepPropsType): import("react/jsx-runtime").JSX.Element;
-    useStep: () => any;
-    Item: ({ id, title, collapse: collapseItem, children, lazyLoad: stepLazyLoad, ...restProps }: import("./propsType").ProStepItemPropsType) => import("react/jsx-runtime").JSX.Element;
-    Listener: ({ children, delayTime, excludes, ...props }: any) => import("react").DetailedReactHTMLElement<any, HTMLElement>;
+    ({ children, ...resetProps }: ProStepType): JSX.Element;
+    useStep: () => Partial<ProStepContextType>;
+    Item: ({ id, title, collapse: collapseItem, children, lazyLoad: stepLazyLoad, order, ...restProps }: import("./propsType").ProStepItemPropsType) => JSX.Element;
+    Listener: ({ children, delayTime, excludes, ...props }: import("./propsType").ListenerProps) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
 };
 export default ProStep;

package/lib/ProStep/index.js

@@ -19,7 +19,9 @@ var _Step = _interopRequireDefault(require("./components/Step"));
 var _Item = _interopRequireDefault(require("./components/Item"));
 var _Listener = _interopRequireDefault(require("./components/Listener"));
 require("./style/index.less");
-var _excluded = ["children"];
+var _excluded = ["children"],
+  _excluded2 = ["id", "form", "title", "validator", "order", "disabled", "lazyLoad"];
+// 创建上下文并提供类型
 var ProStepContext = exports.ProStepContext = /*#__PURE__*/(0, _react.createContext)(null);
 var useStep = exports.useStep = function useStep() {
   return (0, _react.useContext)(ProStepContext) || {};
@@ -82,7 +84,9 @@ var ProStep = function ProStep(_ref) {
       title = _ref4.title,
       validator = _ref4.validator,
       order = _ref4.order,
-      disabled = _ref4.disabled;
+      disabled = _ref4.disabled,
+      lazyLoad = _ref4.lazyLoad,
+      rest = (0, _objectWithoutProperties2.default)(_ref4, _excluded2);
     var record = {};
     record.id = id;
     record.title = title;
@@ -92,7 +96,7 @@ var ProStep = function ProStep(_ref) {
     }
     if (disabled) {
       registerMap.current[id] = record;
-      return null;
+      return;
     }
     var subEvent = /*#__PURE__*/function () {
       var _ref5 = (0, _asyncToGenerator2.default)(/*#__PURE__*/(0, _regeneratorRuntime2.default)().mark(function _callee() {
@@ -140,6 +144,16 @@ var ProStep = function ProStep(_ref) {
     record.subEvent = subEvent;
     registerMap.current[id] = record;
   };
+  // 取消注册
+  var unNotify = function unNotify(keys) {
+    if (typeof keys === 'string') {
+      delete registerMap.current[keys];
+    } else if (Array.isArray(keys)) {
+      keys.forEach(function (key) {
+        delete registerMap.current[key];
+      });
+    }
+  };
   var handleScrollError = function handleScrollError(data) {
     var errorModuleKeys = Object.keys(data).reverse();
     if (errorModuleKeys === null || errorModuleKeys === void 0 ? void 0 : errorModuleKeys.length) {
@@ -244,7 +258,8 @@ var ProStep = function ProStep(_ref) {
       notify: notify,
       triggerTo: triggerTo,
       handleScroll: _utils.handleScroll,
-      lazyLoad: lazyLoad
+      lazyLoad: lazyLoad,
+      unNotify: unNotify
     },
     children: (0, _jsxRuntime.jsxs)("div", {
       className: "pro-step-wrapper",

package/lib/ProStep/propsType.d.ts

@@ -1,42 +1,230 @@
-import { ReactNode } from 'react';
+import { ReactNode, CSSProperties } from 'react';
 import { LazyLoadProps } from 'react-lazyload';
+/**
+ * 步骤项基础类型定义
+ * @interface ItemType
+ */
 export interface ItemType {
+    /** 步骤名称 */
     name: string;
+    /** 步骤唯一标识码 */
     code: string;
+    /** 步骤排序值，越小越靠前 */
     order?: number;
 }
+/**
+ * 已加载地图项属性类型
+ * @interface LoadedMapPropsType
+ */
 export interface LoadedMapPropsType {
+    /** 唯一标识符 */
     id: string;
+    /** 排序值 */
     order: number;
+    /** 标题文本 */
     title: string;
+    /** 是否已加载 */
     loaded: boolean;
 }
+/**
+ * @type LoadedMapType
+ */
+export type LoadedMapType = LoadedMapPropsType;
+/**
+ * ProStep 组件属性类型
+ * @interface ProStepPropsType
+ */
 export interface ProStepPropsType {
-    /** @name 步骤条配置项 */
+    /** 步骤条配置项 */
     dataSource?: ItemType[];
-    /** @name 距离顶部的偏移量 */
+    /** 距离顶部的偏移量（单位：像素） */
     fixedTop: number;
-    /** @name 当前已激活的key */
+    /** 当前激活的步骤标识 */
     activeKey?: string;
-    /** @name 子组件 */
+    /** 子组件内容 */
     children?: ReactNode;
-    /** @name 子组件 */
-    style?: any;
-    /** @name 滚动偏移量 */
+    /** 组件自定义样式 */
+    style?: CSSProperties;
+    /** 滚动偏移量（单位：像素） */
     targetOffset?: number;
-    /** @name 是否使用折叠标题 */
+    /** 是否使用折叠标题 */
     collapse?: boolean;
-    /** @name 是否滚动到第一个报错 */
+    /** 是否自动滚动到第一个报错的步骤 */
     scrollToError?: boolean;
-    /** 模块可视区域懒加载 */
+    /**
+     * 模块可视区域懒加载
+     * @description 为true时使用默认配置，或传入自定义懒加载配置
+     */
     lazyLoad?: boolean | LazyLoadProps;
 }
+/**
+ * ProStep 子项组件属性类型
+ * @interface ProStepItemPropsType
+ */
 export interface ProStepItemPropsType {
+    /** 唯一标识符 */
     id: string;
+    /** 步骤标题 */
     title?: string;
+    /** 是否使用折叠模式 */
     collapse?: boolean;
+    /** 排序值，越小越靠前 */
     order?: number;
-    /** 模块可视区域懒加载 */
+    /**
+     * 模块可视区域懒加载
+     * @description 为true时使用默认配置，或传入自定义懒加载配置
+     */
     lazyLoad?: boolean | LazyLoadProps;
+    /** 允许其他任意属性 */
     [key: string]: any;
 }
+/**
+ * ProStep 子项组件基础类型
+ * @type ProStepItemType
+ */
+export type ProStepItemType = ProStepItemPropsType;
+/**
+ * ProStep组件上下文类型
+ * @interface ProStepContextType
+ */
+export interface ProStepContextType {
+    /** 注册映射引用 */
+    registerMap: React.MutableRefObject<Record<string, RegisterMapItem>>;
+    /** 是否折叠 */
+    collapse?: boolean;
+    /** 注册函数 */
+    register: (params: RegisterParams) => void;
+    /** 通知函数 */
+    notify: (params?: NotifyParams) => Promise<any[]>;
+    /** 触发特定项的函数 */
+    triggerTo: (keys: string[]) => Promise<any[]>;
+    /** 处理滚动的函数 */
+    handleScroll: (id: string, options?: ScrollOptions) => void;
+    /** 懒加载配置 */
+    lazyLoad?: boolean | any;
+    /** 取消注册函数 */
+    unNotify: (keys: string | string[]) => void;
+}
+/**
+ * 注册参数类型
+ * @interface RegisterParams
+ */
+export interface RegisterParams {
+    /** 唯一标识符 */
+    id: string;
+    /** 表单实例 */
+    form?: any;
+    /** 标题 */
+    title: string;
+    /** 自定义验证器 */
+    validator?: () => Promise<any>;
+    /** 排序值 */
+    order: number;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 懒加载配置 */
+    lazyLoad?: boolean | any;
+    /** 允许其他任意属性 */
+    [key: string]: any;
+}
+/**
+ * 注册映射项类型
+ * @interface RegisterMapItem
+ */
+export interface RegisterMapItem {
+    /** 唯一标识符 */
+    id: string;
+    /** 标题 */
+    title: string;
+    /** 排序值 */
+    order: number;
+    /** 提交事件 */
+    subEvent?: () => Promise<any>;
+    /** 允许其他任意属性 */
+    [key: string]: any;
+}
+/**
+ * 通知参数类型
+ * @interface NotifyParams
+ */
+export interface NotifyParams {
+    /** 排除项 */
+    excludes?: string[];
+}
+/**
+ * 滚动选项类型
+ * @interface ScrollOptions
+ */
+export interface ScrollOptions {
+    /** 目标偏移量 */
+    targetOffset?: number;
+    /** 是否滚动到错误位置 */
+    scrollToError?: boolean;
+}
+/**
+ * ProStep监听器属性类型
+ * @interface ListenerProps
+ */
+export interface ListenerProps {
+    /** 子元素 */
+    children: React.ReactElement;
+    /** 延迟时间 */
+    delayTime?: number;
+    /** 排除项 */
+    excludes?: string[];
+    /** 允许其他任意属性 */
+    [key: string]: any;
+}
+/**
+ * 错误结果类型
+ * @interface ErrorResult
+ */
+export interface ErrorResult {
+    /** 错误DOM元素 */
+    errorDom: HTMLElement | null;
+    /** 索引 */
+    index: number;
+}
+/**
+ * 锚点SVG属性类型
+ * @interface AnchorSvgProps
+ */
+export interface AnchorSvgProps {
+    /** 颜色 */
+    color?: string;
+}
+/**
+ * 菜单项属性类型
+ * @interface MenuItemProps
+ */
+export interface MenuItemProps {
+    /** 名称 */
+    name: string;
+    /** 编码 */
+    code: string;
+    /** 是否开启 */
+    onOff: boolean;
+    /** 是否是开始项 */
+    isStart?: boolean;
+    /** 是否是结束项 */
+    isEnd?: boolean;
+    /** 是否禁用 */
+    isDisabled?: boolean;
+    /** 是否是当前步骤 */
+    isCurrentStep?: boolean;
+    /** 是否已检查 */
+    isChecked?: boolean;
+    /** 错误数量 */
+    errorNum?: number;
+    /** 当前数量 */
+    currentNum?: number;
+    /** 目标偏移量 */
+    targetOffset?: number;
+    /** 是否滚动到错误位置 */
+    scrollToError?: boolean;
+}
+/**
+ * ProStep 组件基础类型
+ * @type ProStepType
+ */
+export type ProStepType = ProStepPropsType;

package/lib/ProStep/utils/index.d.ts

@@ -1,5 +1,18 @@
-import type { LoadedMapPropsType } from '../propsType';
-export declare const handleScroll: (id: any, options: any) => void;
-/** 获取加载模块数据信息 */
-export declare const getLoadedMap: (registerMap: any) => LoadedMapPropsType[];
+import React from 'react';
+import type { LoadedMapType } from '../propsType';
+/**
+ * 处理滚动到指定元素位置
+ * @param id 目标元素的ID
+ * @param options 滚动选项
+ */
+export declare const handleScroll: (id: string, options?: {
+    targetOffset?: number;
+    scrollToError?: boolean;
+}) => void;
+/**
+ * 获取加载模块数据信息
+ * @param registerMap 注册映射对象
+ * @returns 模块加载状态列表
+ */
+export declare const getLoadedMap: (registerMap: React.MutableRefObject<Record<string, any>>) => LoadedMapType[];
 export default handleScroll;