@zat-design/sisyphus-react 4.5.5 → 4.5.6-beta.1

package/es/FormsProvider/index.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import type { ModifiedFormInstanceType } from '../ProForm/propsType';
+type Forms = Record<string, ModifiedFormInstanceType<any>>;
+export declare const FormsContext: React.Context<Forms>;
+/**
+ * @param formKey 表单实例key
+ * @param formIst form实例, 如果传了会把传入的实例存入全局
+ * @returns 没有入参: 返回表单实例但是不存入全局
+ *          有formKey: 取全局中的表单实例返回, 如果不存在则创建后返回
+ */
+export declare const useForms: () => Forms;
+/** 获取所有表单实例 */
+export declare const useContextForms: () => Forms;
+interface FormsProviderProps {
+    children?: React.ReactNode;
+}
+declare const FormsProvider: React.FC<FormsProviderProps>;
+export default FormsProvider;

package/es/ProAction/components/CheckModalContent/index.d.ts

@@ -0,0 +1,8 @@
+import './index.less';
+interface propsWithCheckModal {
+    errorTitle?: string;
+    list?: string[];
+    [key: string]: any;
+}
+declare const CheckModalContent: (props: propsWithCheckModal) => import("react/jsx-runtime").JSX.Element;
+export default CheckModalContent;

package/es/ProAction/index.d.ts

@@ -0,0 +1,7 @@
+import React, { PropsWithChildren } from 'react';
+import type { ProActionType } from './propsType';
+import './index.less';
+declare const ProAction: React.FC<PropsWithChildren<{
+    config?: ProActionType[];
+}>>;
+export default ProAction;

package/es/ProAction/propsType.d.ts

@@ -0,0 +1,45 @@
+import { ReactNode } from 'react';
+import { Service, Options } from 'ahooks/lib/useRequest/src/types';
+export interface ProActionType {
+    /**
+     * @description 模式类型：check执行校验并解析错误信息展示，confirm确认提示
+     * @default -
+     */
+    mode?: 'check' | 'confirm';
+    /**
+     * @description 标题
+     * @default -
+     */
+    title?: string | ReactNode;
+    /**
+     * @description 操作回调函数
+     * @param previousData 接上一个 useRequest 返回的值
+     * @param args 接所有链式 useRequest 返回的值
+     * @param index 当前操作的索引
+     * @returns void或Promise<void>
+     * @default -
+     */
+    onAction?: (previousData?: any, args?: any[], index?: number) => void | Promise<void>;
+    /**
+     * @description 自定义请求
+     * @param previousData 接上一个 useRequest 返回的值
+     * @param args 接所有链式 useRequest 返回的值
+     * @returns 包含service、options和transformResponse的对象
+     * @default -
+     */
+    useRequest?: (previousData: any, args: any) => {
+        service?: Service<any, any>;
+        options?: Options<any, any>;
+        transformResponse?: (data: any) => any;
+    };
+    /**
+     * @description 是否中断链式操作
+     * @param previousData 上一个操作的返回数据
+     * @param args 所有链式的数据合集
+     * @returns 布尔值，返回true继续执行，返回false中断操作
+     * @default -
+     */
+    continue?: (previousData: any, args: any[]) => boolean;
+    /** 自定义错误弹窗内容视图渲染 */
+    contextRender?: (data: any) => string | ReactNode;
+}

package/es/ProConfigProvider/index.d.ts

@@ -0,0 +1,9 @@
+import React, { FC } from 'react';
+import 'dayjs/locale/zh-cn';
+import type { ProConfigProviderProps, ConfigContext } from './propsType';
+export declare const ProConfigContext: React.Context<ConfigContext>;
+export declare function useProConfig(): ConfigContext;
+export declare function useProConfig(name: keyof ConfigContext['state']): ConfigContext['state'][keyof ConfigContext['state']];
+export declare const ProConfigProvider: FC<ProConfigProviderProps>;
+export type { ProConfigProviderType, ProConfigProviderProps, GlobalConfig, ProTableGlobalConfig, StorageType, } from './propsType';
+export default ProConfigProvider;

package/es/ProConfigProvider/propsType.d.ts

@@ -0,0 +1,82 @@
+import type React from 'react';
+import type { FormInstance, ThemeConfig } from 'antd';
+import type { PropSelectType } from '../ProSelect/propsType';
+import type { ProModalSelectType } from '../ProForm/components/combination/ProModalSelect/propsType';
+import type { ProCascaderType } from '../ProForm/components/combination/ProCascader/propsType';
+import type { ProEnumConfigType } from '../ProEnum/propsType';
+/** 浏览器缓存类型，与 ProEnum / ProTable 的 StorageType 定义一致 */
+export type StorageType = 'localStorage' | 'sessionStorage' | 'indexedDB';
+/** 项目级全局配置（一处配置，全局生效） */
+export interface GlobalConfig {
+    /** 缓存存储位置，影响 ProTable 列配置缓存与 ProEnum 枚举缓存，默认由各组件自身决定 */
+    storage?: StorageType;
+}
+/** ProTable 组件全局默认配置，通过 ProConfigProvider 统一设置，无需每个实例单独声明 */
+export interface ProTableGlobalConfig {
+    /** 是否开启可伸缩列功能，默认 false */
+    resizeColumn?: boolean;
+    /** 是否开启列配置功能，开启时默认同步开启缓存，默认 false */
+    columnConfig?: boolean | {
+        onColumnOk?: (catchColumns: any, columns: any[]) => Promise<void>;
+    };
+    /** 是否开启列配置缓存，单位为天，true 时缓存一天，默认 false */
+    cacheTime?: number | boolean;
+}
+/** 对外配置项类型（value、内部 state 均为此类型，字段均可选） */
+export interface ProConfigProviderType {
+    locale?: string;
+    /** 项目级全局配置：缓存位置等跨组件通用配置 */
+    globalConfig?: GlobalConfig;
+    /** ProTable 组件全局默认配置 */
+    ProTable?: ProTableGlobalConfig;
+    ProEnum?: Partial<ProEnumConfigType>;
+    ProSelect?: Partial<PropSelectType> & Record<string, any>;
+    ProModalSelect?: Partial<ProModalSelectType> & Record<string, any>;
+    ProAddressBar?: Partial<ProCascaderType> & Record<string, any>;
+    ProCascader?: Partial<ProCascaderType> & Record<string, any>;
+    forms?: Record<string, FormInstance | undefined>;
+    [key: string]: any;
+}
+/** ProConfigProvider 组件 Props（内部使用） */
+export interface ProConfigProviderProps {
+    value?: ProConfigProviderType;
+    locale?: string;
+    /** antd 原生主题配置，用法同 antd ConfigProvider 的 theme，会与内部 ThemeContext 的 antdConfig 深度合并后透传 */
+    theme?: ThemeConfig;
+    onSuccess?: (data: any, params: any) => void;
+    children?: React.ReactNode;
+}
+/** Config 上下文 */
+export interface ConfigContext {
+    state: ProConfigProviderType;
+    dispatch: React.Dispatch<ProConfigActions>;
+}
+/** ThemeAwareConfigProvider 内部组件 Props */
+export interface ThemeAwareConfigProviderProps {
+    locale: any;
+    /** 外部传入的 antd 主题配置，与 ThemeContext 的 antdConfig 合并 */
+    theme?: ThemeConfig;
+    children: React.ReactNode;
+}
+/** Reducer Actions */
+export type ProConfigActions = {
+    type: 'setFormRef';
+    name: string;
+    value: FormInstance;
+} | {
+    type: 'deleteFormRef';
+    name: string;
+} | {
+    type: 'set';
+    payload: ProConfigProviderType;
+} | {
+    type: 'setProEnum';
+    payload: Record<string, any>;
+} | {
+    type: 'setProEnumDic';
+    key: string;
+    payload: any;
+} | {
+    type: 'setWithLocal';
+    payload: ProConfigProviderType;
+};

package/es/ProDownload/index.d.ts

@@ -0,0 +1,6 @@
+import type { ProDownloadType } from './propsType';
+declare const ProDownload: {
+    (props: ProDownloadType): import("react/jsx-runtime").JSX.Element;
+    downLoadRequest: import("./utils").DownloadRequestProps;
+};
+export default ProDownload;

package/es/ProDownload/propsType.d.ts

@@ -0,0 +1,71 @@
+import { ReactNode } from 'react';
+import type { ButtonProps } from 'antd';
+import type { DownloadRequestProps, PropsWithMakeFilePropsType } from './utils';
+export interface ProDownloadType extends ButtonProps {
+    /**
+     * @description       下载资源获取来源：api：通过接口获取，url：通过静态资源链接获取
+     * @default           api
+     */
+    source?: string;
+    /**
+     * @description       下载请求的地址
+     * @default           (必选)
+     */
+    url: string;
+    /**
+     * @description       下载请求的地址
+     * @deprecated        弃用，请使用url进行替换
+     * @default           (非必选)
+     */
+    action?: string;
+    /**
+     * @description       下载请求的类型
+     * @default           post
+     */
+    method?: 'post' | 'get';
+    /**
+     * @description       下载所需额外参数或返回上传额外参数的方法
+     * @default           -
+     */
+    params?: any;
+    /**
+     * @description       下载保存的文件名
+     * @default           (必选)
+     */
+    fileName?: string;
+    /**
+     * @description       设置上传的请求头部，IE10 以上有效
+     * @default           -
+     */
+    headers?: object;
+    /**
+     * @description      禁用状态
+     * @default           false
+     */
+    disabled?: boolean;
+    /** 格式化数据 */
+    transformResponse?: (data: any) => any;
+    /**
+     * @description       上传文件之前的钩子,若返回 false 则停止下载。支持返回一个 Promise 对象，Promise 对象 reject 时则停止下载
+     * @default           -
+     */
+    beforeDownload?: () => boolean | Promise<any>;
+    /**
+     * @description       service 执行完成时触发
+     * @default           -
+     */
+    /**
+     * @description       下载出错的回调
+     * @default           -
+     */
+    onError?: (response: object) => void;
+    onFinish?: () => void;
+    /**
+     * @description       下载按钮的填充内容
+     * @default           -
+     */
+    downLoadRequest?: DownloadRequestProps;
+    downLoadBlobUrl?: PropsWithMakeFilePropsType;
+    children?: string | ReactNode;
+    [key: string]: any;
+}

package/es/ProDownload/utils.d.ts

@@ -0,0 +1,60 @@
+export interface PropsWithMakeFilePropsType {
+    blob?: Blob;
+    fileName: string;
+    url?: string;
+}
+export interface IDownloadRequestPropsType {
+    /**
+     * @description       下载请求的地址
+     * @default           (必选)
+     */
+    url: string;
+    /**
+     * @description       下载请求的类型
+     * @default           post
+     */
+    method?: 'post' | 'get';
+    /**
+     * @description       下载所需额外参数或返回上传额外参数的方法
+     * @default           -
+     */
+    params?: any;
+    headers?: any;
+    /** 格式化数据 */
+    transformResponse?: (data: any) => any;
+    /**
+     * @description       service 执行完成时触发
+     * @default           -
+     */
+    onFinish?: (response: object, params: object) => void;
+    /**
+     * @description       下载保存的文件名
+     * @default           (必选)
+     */
+    fileName?: string;
+    /**
+     * @description       下载出错的回调
+     * @default           -
+     */
+    onError?: (response: object) => void;
+}
+/**
+ * 下载Blob
+ *
+ * @param response
+ * @param fileName
+ * @param extendName
+ * @constructor
+ */
+export declare function BlobMakeFile({ blob, fileName, url }: PropsWithMakeFilePropsType): void;
+export type DownloadRequestProps = (props: IDownloadRequestPropsType) => Promise<Response>;
+type convertBase64ToBlobType = (base64: string, fileType?: string, slice?: number) => Blob;
+export declare const convertBase64ToBlob: convertBase64ToBlobType;
+/**
+ * 从Content-Disposition获取filename
+ * @param contentDisposition string
+ * @returns string
+ */
+export declare function getFilenameFromContentDisposition(contentDisposition: any): string;
+export declare const DownloadRequest: DownloadRequestProps;
+export {};

package/es/ProDrawerForm/components/ProDrawer/index.d.ts

@@ -0,0 +1,7 @@
+import { FC } from 'react';
+import { ProDrawerFormType } from '../../propsType';
+/**
+ * 抽屉组件
+ */
+declare const ProDrawer: FC<ProDrawerFormType>;
+export default ProDrawer;

package/es/ProDrawerForm/components/ProModal/index.d.ts

@@ -0,0 +1,7 @@
+import { FC } from 'react';
+import { ProDrawerFormType } from '../../propsType';
+/**
+ * 弹窗组件
+ */
+declare const ProModal: FC<ProDrawerFormType>;
+export default ProModal;

package/es/ProDrawerForm/components/index.d.ts

@@ -0,0 +1,2 @@
+export { default as ProDrawer } from './ProDrawer';
+export { default as ProModal } from './ProModal';

package/es/ProDrawerForm/hooks/useConfirmClose.d.ts

@@ -0,0 +1,24 @@
+import type { ProDrawerFormType } from '../propsType';
+interface UseConfirmCloseParams {
+    open?: boolean;
+    isView?: boolean;
+    isConfirmClose?: boolean;
+    isConfirmCloseModalProps?: ProDrawerFormType['isConfirmCloseModalProps'];
+    onCancel?: ProDrawerFormType['onCancel'];
+}
+/**
+ * 关闭抽屉/弹窗时的二次确认逻辑
+ *
+ * - markInteracted：绑定到内容容器的 input / change 事件，标记用户真实交互过。
+ *   setFieldsValue 等程序回填不会派发用户输入事件，因此异步回填不会误触发二次确认。
+ * - onConfirm：组件自带关闭入口（右上角 × / 遮罩）的关闭处理。未交互、查看模式或
+ *   未开启二次确认时直接关闭；否则弹出二次确认。底部取消按钮不走此逻辑。
+ * - contextHolder：Modal.useModal 的上下文占位，需渲染进组件，使二次确认弹框能继承
+ *   ConfigProvider 的主题 / 国际化（替代静态 Modal.confirm，消除上下文告警）。
+ */
+export declare const useConfirmClose: ({ open, isView, isConfirmClose, isConfirmCloseModalProps, onCancel, }: UseConfirmCloseParams) => {
+    markInteracted: () => void;
+    onConfirm: () => void;
+    contextHolder: import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>>;
+};
+export {};

package/es/ProDrawerForm/index.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { FormInstance } from 'antd/es/form/Form';
+import { ProDrawerFormType } from './propsType';
+export declare const useProDrawerFormContext: () => any;
+declare const ProDrawerForm: React.ForwardRefExoticComponent<ProDrawerFormType & React.RefAttributes<FormInstance<any>>>;
+export default ProDrawerForm;

package/es/ProDrawerForm/propsType.d.ts

@@ -0,0 +1,111 @@
+import React, { ReactNode } from 'react';
+import type { ModalProps, DrawerProps, FormInstance, ModalFuncProps } from 'antd';
+import type { ProFormType } from '../ProForm/propsType';
+/**
+ * 抽屉尺寸类型定义
+ */
+export type DrawerSizePropsType = 'small' | 'middle' | 'large';
+export type DrawerSizeType = DrawerSizePropsType;
+/**
+ * 显示类型定义
+ */
+export type ShowTypePropsType = 'Modal' | 'Drawer';
+export type ShowType = ShowTypePropsType;
+export interface ProDrawerFormType {
+    /** @name 内部form实例 */
+    form?: FormInstance<any>;
+    /** @name 自定义className */
+    className?: string;
+    /** @name 控制显示隐藏 */
+    open: ModalProps['open'] | DrawerProps['open'];
+    /** @name 标题 */
+    title?: ModalProps['title'] | DrawerProps['title'];
+    /** @name 点击蒙层是否允许关闭 */
+    maskClosable?: ModalProps['maskClosable'] | DrawerProps['maskClosable'];
+    /** @name 禁止选项 */
+    disabled?: boolean | undefined;
+    /** @name 是否查看模式 */
+    isView?: boolean | undefined;
+    /**
+     * @name 宽度
+     * @deprecated 请改用 `size`，`width` 仅作向后兼容保留，后续版本将移除
+     */
+    width?: string | number;
+    /** @name 取消按钮文字 */
+    cancelText?: ModalProps['cancelText'];
+    /** @name 确认按钮文字 */
+    okText?: ModalProps['okText'];
+    /** @name 确认按钮loading状态 */
+    okLoading?: boolean;
+    /** @name 确认按钮禁用状态 */
+    okDisabled?: boolean;
+    /** @name 显示方式 */
+    mode?: ShowType;
+    /**
+     * @name 尺寸
+     * @description 设计规范三档枚举（small/middle/large），亦支持自定义数字 / 像素 / 百分比
+     */
+    size?: DrawerSizeType | number | string;
+    /**
+     * @name 自动选中第一项
+     * @description 只对有input的类型有效
+     */
+    autoFocusFirstInput?: boolean;
+    /**
+     * @name 关闭时是否开启二次确认弹框
+     * @description 只对Drawer的类型有效
+     */
+    isConfirmClose?: boolean;
+    /**
+     * @name 关闭时二次确认弹框的属性
+     * @description 只对Drawer的类型有效
+     */
+    isConfirmCloseModalProps?: Omit<ModalFuncProps, 'content' | 'onOk' | 'onCancel'>;
+    /**
+     * @name 底部默认取消按钮事件
+     * @returns 返回Promise或布尔值可控制弹窗关闭行为
+     */
+    onCancel?: () => Promise<boolean | void | unknown> | boolean | void | unknown;
+    /**
+     * @name 底部默认确定按钮事件
+     * @param values 表单值
+     * @param form 表单实例
+     * @returns 返回Promise或布尔值可控制弹窗关闭行为
+     */
+    onOk?: (values?: any, form?: FormInstance) => Promise<boolean | void | unknown> | boolean | void | unknown;
+    /**
+     * @name 底部自定义按钮配置
+     */
+    footer?: ReactNode | ReactNode[];
+    /**
+     * @name 底部左侧自定义渲染
+     */
+    extraLeft?: ReactNode;
+    /**
+     * @name proForm的属性
+     * @description 配置后children不展示
+     */
+    proFormProps?: Omit<ProFormType, 'form'>;
+    /**
+     * @name 弹框的属性
+     */
+    modalProps?: ModalProps;
+    /**
+     * @name 抽屉的属性
+     */
+    drawerProps?: DrawerProps;
+    /**
+     * @name 关闭时弹框或者抽屉是否清空formValues
+     */
+    onCloseClean?: boolean;
+    /**
+     * @name 隐藏时销毁内容
+     * @description 透传给底层 antd Drawer/Modal
+     */
+    destroyOnHidden?: ModalProps['destroyOnHidden'] | DrawerProps['destroyOnHidden'];
+    /** @name 子组件 */
+    children?: React.ReactNode;
+    /** @name z轴层级 */
+    zIndex?: number;
+}
+export type ProDrawerFormPropsType = ProDrawerFormType;

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

@@ -0,0 +1,25 @@
+import { DrawerSizeType } from '../propsType';
+/**
+ * 将枚举值转成数值px，暴露枚举，隐藏真实数值，暂时不让用户自定义
+ * @param size 设计规范的三个尺寸  460 960 1200 对应 'small' | 'middle' | 'large'
+ */
+export declare const transformBySize: (size: DrawerSizeType) => number;
+/**
+ * 解析最终尺寸
+ *
+ * - 显式传入（已废弃的）`width` 时打印警告并优先生效，保证向后兼容。
+ * - `size` 命中三档枚举走 `transformBySize`；否则视为自定义数字 / 像素 / 百分比直接返回。
+ */
+export declare const resolveDrawerSize: (size: DrawerSizeType | number | string | undefined, width: number | string | undefined) => number | string | undefined;
+/**
+ * 关闭抽屉时是否需要弹出二次确认
+ *
+ * 判定「用户是否真实改动过」依据 userInteracted —— 它由抽屉内容容器上监听到的
+ * 真实用户输入事件（input / change）置位。打开后通过 setFieldsValue 异步回填
+ * 详情数据属于程序行为，不会派发这些用户事件，因此不会误触发二次确认。
+ */
+export declare const shouldConfirmClose: (params: {
+    isView?: boolean;
+    isConfirmClose?: boolean;
+    userInteracted: boolean;
+}) => boolean;

package/es/ProEditLabel/components/RenderProForm.d.ts

@@ -0,0 +1,4 @@
+import { FC } from 'react';
+import type { PopupType } from '../propsType';
+declare const RenderProForm: FC<PopupType>;
+export default RenderProForm;

package/es/ProEditLabel/index.d.ts

@@ -0,0 +1,4 @@
+import { FC } from 'react';
+import type { ContainerType, LabelType, ProEditLabelType } from './propsType';
+declare const ProEditLabel: FC<LabelType & ProEditLabelType & ContainerType>;
+export default ProEditLabel;

package/es/ProEditLabel/propsType.d.ts

@@ -0,0 +1,163 @@
+import { InputProps } from 'antd/es/input';
+import { PopconfirmProps } from 'antd/es/popconfirm';
+import { FormInstance } from 'antd/es/form';
+import React from 'react';
+import type { ProFormColumnType } from '../ProForm/propsType';
+export interface ContainerType {
+    /**
+     * @description 触发方式
+     * @default "click"
+     */
+    trigger?: 'click' | 'hover';
+    /**
+     * @description 尺寸
+     * @default "middle"
+     */
+    size?: 'small' | 'middle' | 'large';
+    /**
+     * @description 显示模式
+     * @default "popup"
+     */
+    mode?: 'popup' | 'current';
+    /**
+     * @description 类型
+     * @default "input"
+     */
+    type?: 'input' | 'select';
+}
+export interface StateType {
+    /**
+     * @description 弹出值
+     * @default ""
+     */
+    popValue?: string;
+    /**
+     * @description 确认值
+     * @default ""
+     */
+    confirmValue?: string;
+}
+export interface PopupType {
+    /**
+     * @description 类型
+     * @default -
+     */
+    type?: string;
+    /**
+     * @description 标签
+     * @default -
+     */
+    label?: string | React.ReactNode;
+    /**
+     * @description 标题
+     * @default -
+     */
+    title?: string | React.ReactNode;
+    /**
+     * @description 提示
+     * @default -
+     */
+    tip?: string | React.ReactNode;
+    /**
+     * @description 是否去除空格
+     * @default false
+     */
+    trim?: boolean;
+    /**
+     * @description 标签宽度
+     * @default -
+     */
+    labelWidth?: string | number;
+    /**
+     * @description 字段属性
+     * @default -
+     */
+    fieldProps?: any;
+    /**
+     * @description 列配置
+     * @default -
+     */
+    columns?: ProFormColumnType[];
+    /**
+     * @description 允许扩展字段
+     */
+    [key: string]: any;
+}
+export interface LabelType extends Omit<InputProps, 'onChange'> {
+    /**
+     * @description 是否打开
+     * @default false
+     */
+    open?: boolean;
+    /**
+     * @description 可见性变化回调
+     * @default -
+     */
+    onOpenChange?: (open: boolean) => void;
+    /**
+     * @description 值变化回调
+     * @default -
+     */
+    onChange?: (value: any) => void;
+    /**
+     * @description 是否可编辑
+     * @default false
+     */
+    editable?: boolean;
+    /**
+     * @description 编辑回调
+     * @default -
+     */
+    onEdit?: () => void;
+}
+export interface ProEditLabelType extends Partial<PopconfirmProps> {
+    /**
+     * @description 弹出属性
+     * @default -
+     */
+    popupProps?: PopupType;
+    /**
+     * @description 空值显示
+     * @default "-"
+     */
+    viewEmpty?: '-';
+    /**
+     * @description 确认回调
+     * @default -
+     */
+    onConfirm?: (e?: any) => void;
+    /**
+     * @description 完成回调
+     * @default -
+     */
+    onFinish?: (e?: any) => void;
+    /**
+     * @description 打开状态变化回调
+     * @default -
+     */
+    onOpenChange?: (e?: any) => void;
+    /**
+     * @description 触发方式
+     * @default "click"
+     */
+    trigger?: 'click' | 'hover';
+    /**
+     * @description 值
+     * @default -
+     */
+    value?: any;
+    /**
+     * @description 表单实例
+     * @default -
+     */
+    form?: FormInstance;
+    /**
+     * @description 是否禁用
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * @description 允许扩展字段
+     */
+    [key: string]: any;
+}