@zat-design/sisyphus-react 3.11.13 → 3.11.14-beta.10

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 { 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/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, ...restProps }: ProStepItemType) => import("react/jsx-runtime").JSX.Element;
 export default ProStepItem;

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,10 +1,10 @@
 /// <reference types="react" />
-import { ProStepPropsType } from './propsType';
+import { ProStepType } from './propsType';
 import './style/index.less';
 export declare const ProStepContext: import("react").Context<any>;
 export declare const useStep: () => any;
 declare const ProStep: {
-    ({ children, ...resetProps }: ProStepPropsType): import("react/jsx-runtime").JSX.Element;
+    ({ children, ...resetProps }: ProStepType): 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>;

package/lib/ProStep/index.js

@@ -140,6 +140,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 +254,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,90 @@
-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 组件基础类型
+ * @type ProStepType
+ */
+export type ProStepType = ProStepPropsType;
+/**
+ * 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;

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

@@ -1,5 +1,5 @@
-import type { LoadedMapPropsType } from '../propsType';
+import type { LoadedMapType } from '../propsType';
 export declare const handleScroll: (id: any, options: any) => void;
 /** 获取加载模块数据信息 */
-export declare const getLoadedMap: (registerMap: any) => LoadedMapPropsType[];
+export declare const getLoadedMap: (registerMap: any) => LoadedMapType[];
 export default handleScroll;

package/lib/ProTable/components/FormatColumn/index.d.ts

@@ -2,9 +2,9 @@
  * 调整点：
  */
 import React from 'react';
-import { ProTableColumn } from '../../propsType';
+import type { ProTableColumnType } from '../../propsType';
 export declare const formatColumn: ({ column, originalObj, rowKey, wrapToolTipProps, scroll, onUpdateMinWidth, isInNewRow, diffConfig, }: {
-    column: ProTableColumn;
+    column: ProTableColumnType;
     originalObj: any;
     rowKey: any;
     wrapToolTipProps?: any;

package/lib/ProTable/components/FormatColumn/index.js

@@ -222,7 +222,7 @@ var formatColumn = exports.formatColumn = function formatColumn(_ref2) {
   }
   var valueTypePrecision = precision;
   if (['percentage', 'permillage', 'thousandth', 'thousandthCNY'].includes(valueType)) {
-    valueTypePrecision = precision || 2;
+    valueTypePrecision = precision !== null && precision !== void 0 ? precision : 2;
   }
   // 百分比、千分比
   if (['percentage', 'permillage'].includes(valueType)) {
@@ -270,7 +270,7 @@ var formatColumn = exports.formatColumn = function formatColumn(_ref2) {
     // 千分位, 千分位带CNY前缀
   } else if (['thousandth', 'thousandthCNY'].includes(valueType)) {
     column.render = function (value, record, index) {
-      var valueStr = valueTypePrecision ? "".concat(Number(value).toFixed(valueTypePrecision)) : "".concat(value);
+      var valueStr = valueTypePrecision || valueTypePrecision === 0 ? "".concat(Number(value).toFixed(valueTypePrecision)) : "".concat(value);
       var renderValue = valueStr.replace(/\B(?=(\d{3})+(?!\d))/g, ',');
       var originalResult = (0, _utils2.getOriginalValue)(value, record, originalObj, rowKey, dataIndex);
       var isChanged = originalResult.isChanged,

package/lib/ProTable/hooks/useAntdTable.d.ts

@@ -1,7 +1,7 @@
 import { Key } from 'react';
 import { useRequest } from 'ahooks';
-import { RequestOptions, Service } from '../propsType';
-declare function useAntdTable<I, R extends Record<string, any>, S extends Service<I, R>>(service: S, options?: RequestOptions<I, R>, useRequestOptions?: Parameters<typeof useRequest>[1]): {
+import type { ProTableRequestOptionsType, ProTableServiceType } from '../propsType';
+declare function useAntdTable<I, R extends Record<string, any>, S extends ProTableServiceType<I, R>>(service: S, options?: ProTableRequestOptionsType<I, R>, useRequestOptions?: Parameters<typeof useRequest>[1]): {
     data: R[];
     params: any;
     rowSelection: {

package/lib/ProTable/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { ProTableProps } from './propsType';
+import type { ProTableType } from './propsType';
 import useAntdTable from './hooks/useAntdTable';
 export declare const TableContext: import("react").Context<{}>;
 export declare const defaultPage: {
@@ -7,7 +7,7 @@ export declare const defaultPage: {
     pageSize: number;
 };
 declare const ProTable: {
-    (props: ProTableProps): import("react/jsx-runtime").JSX.Element;
+    (props: ProTableType): import("react/jsx-runtime").JSX.Element;
     defaultProps: {
         quickConfig: boolean;
         stripe: boolean;