@pisell/materials 1.0.983 → 1.0.988

package/lib/components/PisellProcedure/types.d.ts

@@ -1,303 +1,363 @@
-import React from 'react';
-import type { ButtonProps } from 'antd';
-import type { PisellStepsProps, StepItem } from '../PisellSteps/types';
+import type { CSSProperties, ReactNode } from 'react';
+import type { PisellStepsProps } from '../PisellSteps/types';
 /**
- * 布局方向类型
+ * 步骤项数据
  */
-export declare type LayoutDirection = 'vertical' | 'horizontal';
-/**
- * 操作区定位模式
- */
-export declare type ActionMode = 'fixed' | 'embedded' | 'float';
+export interface StepItem {
+    /** 步骤索引 */
+    index?: number;
+    /** 步骤标题 */
+    title?: ReactNode;
+    /** 步骤描述 */
+    description?: ReactNode;
+    /** 其他数据 */
+    [key: string]: any;
+}
 /**
- * 操作区定位位置
+ * 步骤变化结果
  */
-export declare type ActionPosition = 'bottom' | 'content' | 'summary';
+export interface StepChangeResult {
+    /** 是否成功 */
+    success: boolean;
+    /** 当前步骤索引 */
+    currentStep: number;
+    /** 当前步骤数据 */
+    currentItem: StepItem | null;
+}
 /**
- * 头部固定模式
+ * PisellProcedure Ref 暴露的方法
+ * @description 通过 ref 可以调用的组件方法
  */
-export declare type HeaderFixed = boolean | 'scroll';
+export interface PisellProcedureRef {
+    /**
+     * 跳转到上一步
+     * @returns 步骤变化结果，如果无法跳转则返回 null
+     */
+    goPrev: () => StepChangeResult | null;
+    /**
+     * 跳转到下一步
+     * @returns 步骤变化结果，如果无法跳转则返回 null
+     */
+    goNext: () => StepChangeResult | null;
+    /**
+     * 跳转到指定步骤
+     * @param step - 目标步骤索引
+     * @returns 步骤变化结果，如果无法跳转则返回 null
+     */
+    goToStep: (step: number) => StepChangeResult | null;
+    /**
+     * 获取当前步骤索引
+     * @returns 当前步骤索引
+     */
+    getCurrentStep: () => number;
+    /**
+     * 打开移动端总结弹窗
+     */
+    openSummaryModal: () => void;
+    /**
+     * 关闭移动端总结弹窗
+     */
+    closeSummaryModal: () => void;
+}
 /**
- * 操作按钮配置项
+ * 返回确认弹窗配置
  */
-export interface ActionItem {
-    /** 唯一标识 */
-    key: string;
-    /** 按钮文本 */
-    label: React.ReactNode;
-    /** 按钮类型 */
-    type?: 'primary' | 'default' | 'dashed' | 'link' | 'text';
-    /** 点击回调 */
-    onClick?: () => void | Promise<void>;
-    /** 是否禁用 */
-    disabled?: boolean;
-    /** 是否加载中 */
-    loading?: boolean;
-    /** 按钮图标 */
-    icon?: React.ReactNode;
-    /** 排序权重（越小越靠前） */
-    order?: number;
-    /** 是否隐藏 */
-    hidden?: boolean;
-    /** 自定义类名 */
-    className?: string;
-    /** 自定义样式 */
-    style?: React.CSSProperties;
-    /** 其他按钮属性 */
-    [key: string]: any;
+export interface BackConfirmModalConfig {
+    /**
+     * 是否启用返回确认弹窗
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * 弹窗标题
+     * @description 支持字符串格式
+     */
+    title?: string;
+    /**
+     * 弹窗描述内容
+     * @description 支持字符串格式
+     */
+    describe?: string;
+    /**
+     * 弹窗底部插槽
+     * @description 底部按钮区域，支持放置任意内容
+     */
+    footer?: ReactNode;
 }
 /**
- * PisellProcedure 组件属性
+ * 头部插槽顺序
  */
-export interface PisellProcedureProps {
-    /** 当前步骤索引（从 0 开始） */
-    current?: number;
-    /** 步骤配置数组（传递给 PisellSteps 组件） */
-    steps: StepItem[];
-    /** 步骤改变时的回调 */
-    onStepChange?: (current: number) => void | Promise<void>;
-    /** 点击关闭按钮的回调 */
-    onClose?: () => void;
-    /** 点击上一步按钮的回调 */
-    onPrev?: () => void;
-    /** 内容区渲染函数 */
-    contentRender: (current: number) => React.ReactNode;
-    /** 信息总结区渲染函数 */
-    summaryRender?: (current: number) => React.ReactNode;
-    /** 操作按钮配置数组 */
-    actions?: ActionItem[];
-    /** 整体布局方向 */
-    layout?: LayoutDirection;
-    /** 主体区域布局方向 */
-    bodyLayout?: LayoutDirection;
-    /** 内容区宽度（百分比或固定值） */
-    contentWidth?: string | number;
-    /** 信息总结区宽度（固定值） */
-    summaryWidth?: string | number;
-    /** 是否显示头部区域 */
-    showHeader?: boolean;
-    /** 是否显示信息总结区 */
-    showSummary?: boolean;
-    /** 是否显示操作区 */
-    showAction?: boolean;
-    /** 是否显示上一步按钮 */
-    showPrevButton?: boolean;
-    /** 是否显示关闭按钮 */
-    showCloseButton?: boolean;
-    /** 头部区域是否固定定位 */
-    headerFixed?: HeaderFixed;
-    /** 操作区定位模式 */
-    actionMode?: ActionMode;
-    /** 操作区定位位置 */
-    actionPosition?: ActionPosition;
-    /** 信息总结区是否可折叠 */
-    summaryCollapsible?: boolean;
-    /** 信息总结区默认是否折叠 */
-    summaryDefaultCollapsed?: boolean;
-    /** 步骤切换前是否自动验证 */
-    validateOnStepChange?: boolean;
-    /** 步骤验证函数 */
-    onValidate?: (current: number) => boolean | Promise<boolean>;
-    /** 返回上一步是否清除当前步骤数据 */
-    clearOnBack?: boolean;
-    /** 数据改变影响当前步骤时是否弹窗确认 */
-    confirmOnDataChange?: boolean;
-    /** 头部区域自定义类名 */
-    headerClassName?: string;
-    /** 头部区域自定义样式 */
-    headerStyle?: React.CSSProperties;
-    /** 内容区自定义类名 */
-    contentClassName?: string;
-    /** 内容区自定义样式 */
-    contentStyle?: React.CSSProperties;
-    /** 信息总结区自定义类名 */
-    summaryClassName?: string;
-    /** 信息总结区自定义样式 */
-    summaryStyle?: React.CSSProperties;
-    /** 操作区自定义类名 */
-    actionClassName?: string;
-    /** 操作区自定义样式 */
-    actionStyle?: React.CSSProperties;
-    /** 组件根节点自定义类名 */
-    className?: string;
-    /** 组件根节点自定义样式 */
-    style?: React.CSSProperties;
-    /** 头部区域额外内容插槽 */
-    headerExtra?: React.ReactNode;
-    /** 信息总结区额外内容插槽 */
-    summaryExtra?: React.ReactNode;
-    /** 操作区额外内容插槽 */
-    actionExtra?: React.ReactNode;
-    /** 传递给 PisellSteps 组件的额外属性 */
-    stepsProps?: Partial<PisellStepsProps>;
-    /** 上一步按钮的属性 */
-    prevButtonProps?: ButtonProps;
-    /** 关闭按钮的属性 */
-    closeButtonProps?: ButtonProps;
-    /** 是否显示加载状态 */
-    loading?: boolean;
-    /** 是否禁用所有操作 */
-    disabled?: boolean;
-}
+export declare type HeaderSlotOrder = 'default' | 'reverse';
 /**
- * ProcedureHeader 组件属性（内部子组件）
+ * ProcedureHeader 头部区域配置
  */
 export interface ProcedureHeaderProps {
-    /** 当前步骤索引 */
-    current: number;
-    /** 步骤配置数组 */
-    steps: StepItem[];
-    /** 传递给 PisellSteps 的额外属性 */
-    stepsProps?: Partial<PisellStepsProps>;
-    /** 是否显示上一步按钮 */
-    showPrevButton: boolean;
-    /** 是否显示关闭按钮 */
-    showCloseButton: boolean;
-    /** 点击上一步的回调 */
-    onPrev?: () => void;
-    /** 点击关闭的回调 */
-    onClose?: () => void;
-    /** 点击步骤的回调 */
-    onStepClick?: (index: number) => void;
-    /** 额外内容插槽 */
-    headerExtra?: React.ReactNode;
-    /** 上一步按钮属性 */
-    prevButtonProps?: ButtonProps;
-    /** 关闭按钮属性 */
-    closeButtonProps?: ButtonProps;
-    /** 是否固定定位 */
-    fixed?: HeaderFixed;
     /** 自定义类名 */
     className?: string;
     /** 自定义样式 */
-    style?: React.CSSProperties;
-    /** 是否禁用 */
-    disabled?: boolean;
+    style?: CSSProperties;
+    /** 左侧插槽（上一步按钮、返回图标等） */
+    left?: ReactNode;
+    /** 右侧插槽（关闭按钮、图标等） */
+    right?: ReactNode;
+    /**
+     * 插槽顺序
+     * @description 'default' - 默认顺序（left 在左，right 在右），'reverse' - 反转顺序（left 在右，right 在左）
+     * @default 'default'
+     */
+    slotOrder?: HeaderSlotOrder;
+    /** 步骤条配置，透传给 PisellSteps 组件 */
+    stepsProps?: PisellStepsProps;
+    /**
+     * 是否显示步骤条
+     * @default true
+     */
+    showSteps?: boolean;
+    /**
+     * 第一步时是否显示返回按钮
+     * @default false
+     */
+    showBackOnFirstStep?: boolean;
+    /**
+     * 返回上一步确认弹窗配置
+     */
+    backConfirmModal?: BackConfirmModalConfig;
+    /**
+     * 关闭确认弹窗配置
+     */
+    closeConfirmModal?: BackConfirmModalConfig;
 }
 /**
- * ProcedureContent 组件属性（内部子组件）
+ * 主体区域布局模式
  */
-export interface ProcedureContentProps {
-    /** 当前步骤索引 */
-    current: number;
-    /** 内容渲染函数 */
-    contentRender: (current: number) => React.ReactNode;
-    /** 宽度 */
-    width?: string | number;
-    /** 自定义类名 */
-    className?: string;
-    /** 自定义样式 */
-    style?: React.CSSProperties;
-    /** 是否加载中 */
-    loading?: boolean;
-}
+export declare type BodyLayoutMode = 'fixed' | 'ratio';
 /**
- * ProcedureSummary 组件属性（内部子组件）
+ * 内容区与信息区的比例配置
+ * @example '7:3' | '6:4'
  */
-export interface ProcedureSummaryProps {
-    /** 当前步骤索引 */
-    current: number;
-    /** 信息总结区渲染函数 */
-    summaryRender?: (current: number) => React.ReactNode;
-    /** 宽度 */
-    width?: string | number;
-    /** 是否可折叠 */
-    collapsible?: boolean;
-    /** 默认是否折叠 */
-    defaultCollapsed?: boolean;
-    /** 折叠状态改变的回调 */
-    onCollapseChange?: (collapsed: boolean) => void;
-    /** 额外内容插槽 */
-    summaryExtra?: React.ReactNode;
-    /** 自定义类名 */
-    className?: string;
-    /** 自定义样式 */
-    style?: React.CSSProperties;
-    /** 是否显示 */
-    visible?: boolean;
-}
+export declare type BodyLayoutRatio = `${number}:${number}`;
 /**
- * ProcedureAction 组件属性（内部子组件）
+ * 主体区域排列方向
  */
-export interface ProcedureActionProps {
-    /** 操作按钮配置数组 */
-    actions: ActionItem[];
-    /** 定位模式 */
-    mode?: ActionMode;
-    /** 定位位置 */
-    position?: ActionPosition;
-    /** 额外内容插槽 */
-    actionExtra?: React.ReactNode;
-    /** 自定义类名 */
-    className?: string;
-    /** 自定义样式 */
-    style?: React.CSSProperties;
-    /** 是否禁用所有按钮 */
-    disabled?: boolean;
-    /** 是否加载中 */
-    loading?: boolean;
-}
+export declare type BodyDirection = 'horizontal' | 'vertical';
 /**
- * MobileSummaryDrawer 组件属性（内部子组件）
+ * 主体区域内容顺序
  */
-export interface MobileSummaryDrawerProps {
-    /** 当前步骤索引 */
-    current: number;
-    /** 信息总结区渲染函数 */
-    summaryRender?: (current: number) => React.ReactNode;
-    /** 是否可见 */
-    visible: boolean;
-    /** 可见状态改变的回调 */
-    onVisibleChange: (visible: boolean) => void;
-    /** 额外内容插槽 */
-    summaryExtra?: React.ReactNode;
+export declare type BodyContentOrder = 'content-first' | 'sidebar-first';
+/**
+ * ProcedureBody 主体区域配置
+ */
+export interface ProcedureBodyProps {
     /** 自定义类名 */
     className?: string;
     /** 自定义样式 */
-    style?: React.CSSProperties;
+    style?: CSSProperties;
+    /**
+     * 排列方向
+     * @description 'horizontal' - 横向排列（左右布局），'vertical' - 纵向排列（上下布局）
+     * @default 'horizontal'
+     */
+    direction?: BodyDirection;
+    /**
+     * 内容顺序
+     * @description 'content-first' - 内容区在前（默认：横向时内容区在左，纵向时内容区在上）
+     * @description 'sidebar-first' - 信息区在前（横向时信息区在左，纵向时信息区在上）
+     * @default 'content-first'
+     */
+    contentOrder?: BodyContentOrder;
+    /**
+     * 布局模式
+     * @description 'fixed' - 固定宽度（信息区宽度随屏幕断点变化）
+     * @description 'ratio' - 比例布局（按设定比例分配宽度）
+     * @default 'fixed'
+     */
+    layoutMode?: BodyLayoutMode;
+    /**
+     * 内容区与信息区的比例
+     * @description 仅在 layoutMode='ratio' 时生效
+     * @example '7:3' - 内容区占 70%，信息区占 30%
+     * @default '7:3'
+     */
+    layoutRatio?: BodyLayoutRatio;
+    /** 内容区插槽 */
+    contentSlot?: ReactNode;
+    /** 内容区类名 */
+    contentClassName?: string;
+    /** 内容区样式 */
+    contentStyle?: CSSProperties;
+    /** 信息区插槽 */
+    sidebarSlot?: ReactNode;
+    /** 信息区类名 */
+    sidebarClassName?: string;
+    /** 信息区样式 */
+    sidebarStyle?: CSSProperties;
+    /**
+     * 信息区容器选择器（类名或 ID）
+     * @description 用于计算信息区高度的容器元素，支持类名（如 '.modal-container'）或 ID（如 '#dialog-container'）
+     * @description 如果不提供，则使用 window.innerHeight 作为基准
+     */
+    sidebarContainerSelector?: string;
 }
 /**
- * 响应式信息类型
+ * 底部操作区位置模式
  */
-export interface ResponsiveInfo {
-    /** < 430px */
-    xs: boolean;
-    /** < 744px */
-    sm: boolean;
-    /** < 960px */
-    md: boolean;
-    /** < 1133px */
-    lg: boolean;
-    /** < 1366px */
-    xl: boolean;
-}
+export declare type FooterPositionMode = 'fixed-bottom' | 'fixed-content-bottom' | 'fixed-sidebar-bottom' | 'float-all' | 'float-content' | 'float-sidebar';
 /**
- * 步骤验证结果
+ * ProcedureFooter 底部区域配置
  */
-export interface ValidationResult {
-    /** 是否验证通过 */
-    valid: boolean;
-    /** 错误信息 */
-    message?: string;
-    /** 错误字段 */
-    errors?: Record<string, string>;
+export interface ProcedureFooterProps {
+    /** 自定义类名 */
+    className?: string;
+    /** 自定义样式 */
+    style?: CSSProperties;
+    /**
+     * 左侧插槽
+     * @description 底部左侧区域，可放置自定义内容（如总价信息、提示文案等）
+     */
+    leftSlot?: ReactNode;
+    /**
+     * 右侧操作按钮组
+     * @description 底部右侧区域，放置操作按钮（如上一步、下一步、提交等）
+     */
+    actions?: ReactNode;
+    /**
+     * 移动端总结按钮插槽
+     * @description 当宽度小于744px时显示，点击可弹窗展示信息区内容
+     */
+    summaryButton?: ReactNode;
+    /**
+     * 移动端弹窗标题
+     * @description summaryButton 点击后弹窗的标题
+     * @default '详情'
+     */
+    summaryModalTitle?: string;
+    /**
+     * More 按钮文案
+     * @default 'More'
+     */
+    moreText?: string;
+    /**
+     * 是否启用溢出收纳功能
+     * @description 当宽度不足时，将次序列的按钮收纳到 More 菜单中
+     * @default true
+     */
+    enableOverflow?: boolean;
+    /**
+     * 底部操作区位置模式
+     * @description 控制底部操作区的展示位置
+     * @default 'float-sidebar'
+     */
+    position?: FooterPositionMode;
 }
 /**
- * 数据同步配置
+ * 组件使用模式
  */
-export interface DataSyncConfig {
-    /** 是否需要确认 */
-    needConfirm: boolean;
-    /** 确认标题 */
-    confirmTitle?: string;
-    /** 确认内容 */
-    confirmContent?: string;
-    /** 确认按钮文本 */
-    confirmOkText?: string;
-    /** 取消按钮文本 */
-    confirmCancelText?: string;
-}
+export declare type ProcedureMode = 'page' | 'modal';
 /**
- * 导出所有类型
+ * PisellProcedure 组件 Props
+ * @description 流程容器组件，用于管理多步骤流程的复合容器
  */
-export type { StepItem, PisellStepsProps, } from '../PisellSteps/types';
+export interface PisellProcedureProps {
+    /**
+     * 自定义类名
+     */
+    className?: string;
+    /**
+     * 自定义样式
+     */
+    style?: CSSProperties;
+    /**
+     * 组件使用模式
+     * @description 'page' - 页面模式（默认），'modal' - 弹窗模式
+     * @description 弹窗模式下：不应用移动端模式、不隐藏信息部分、不设置底部为固定悬浮、不显示移动端总结按钮、不执行响应式类名计算
+     * @default 'page'
+     */
+    mode?: ProcedureMode;
+    /**
+     * 是否显示头部区域
+     * @default true
+     */
+    showHeader?: boolean;
+    /**
+     * 是否显示信息区（侧边栏）
+     * @default true
+     */
+    showSidebar?: boolean;
+    /**
+     * 是否显示底部区域
+     * @default true
+     */
+    showFooter?: boolean;
+    /**
+     * 默认当前步骤
+     * @default 0
+     */
+    defaultCurrent?: number;
+    /**
+     * 步骤变化回调
+     * @description 当步骤变化时触发，返回步骤变化结果
+     */
+    onStepsChange?: (result: StepChangeResult) => void;
+    /**
+     * 头部区域配置
+     */
+    headerProps?: ProcedureHeaderProps;
+    /**
+     * 主体区域配置
+     */
+    bodyProps?: ProcedureBodyProps;
+    /**
+     * 底部区域配置
+     */
+    footerProps?: ProcedureFooterProps;
+    /**
+     * 上一步事件回调
+     * @description 当触发上一步操作时调用（在步骤更新之前触发）
+     * @param current - 当前步骤索引
+     * @returns 返回 false 可以阻止步骤更新
+     */
+    onPrev?: (current: number) => boolean | void;
+    /**
+     * 下一步事件回调
+     * @description 当触发下一步操作时调用（在步骤更新之前触发）
+     * @param current - 当前步骤索引
+     * @returns 返回 false 可以阻止步骤更新
+     */
+    onNext?: (current: number) => boolean | void;
+    /**
+     * 首步返回按钮点击回调
+     * @description 当在第一步且 showBackOnFirstStep 为 true 时，点击返回按钮触发此回调。如果不传递，默认跳转到首页（/）
+     */
+    onFirstStepBack?: () => void;
+    /**
+     * 关闭按钮点击回调
+     */
+    onClose?: () => void;
+    /**
+     * 返回确认弹窗按钮回调
+     * @description 当点击返回确认弹窗的按钮时触发
+     * @param action - 'cancel' 点击清除按钮, 'ok'/'confirm' 点击保留按钮
+     */
+    onBackConfirm?: (action: 'cancel' | 'ok' | 'confirm') => void;
+    /**
+     * 关闭确认弹窗按钮回调
+     * @description 当点击关闭确认弹窗的按钮时触发
+     * @param action - 'cancel' 点击取消按钮, 'ok'/'confirm' 点击确认按钮
+     */
+    onCloseConfirm?: (action: 'cancel' | 'ok' | 'confirm') => void;
+    /**
+     * 设计模式标识
+     * @description 低代码引擎使用
+     */
+    __designMode?: 'design' | 'preview';
+    /**
+     * 组件唯一标识
+     * @description 低代码引擎使用
+     */
+    __id?: string;
+    /**
+     * 其他扩展配置
+     * @description 用于透传额外属性
+     */
+    other?: Record<string, any>;
+}

package/lib/components/PisellProcedure/utils/classNames.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 类名合并工具函数
+ * @description 用于合并多个类名，过滤掉 undefined、null、空字符串
+ */
+/**
+ * 合并类名
+ * @param classNames 类名数组
+ * @returns 合并后的类名字符串
+ * @example
+ * mergeClassNames('base', 'active', undefined, 'extra')
+ * // => 'base active extra'
+ */
+export declare const mergeClassNames: (...classNames: (string | undefined | null | false)[]) => string;
+/**
+ * 生成带前缀的类名
+ * @param prefix 前缀
+ * @param suffix 后缀（可选）
+ * @returns 类名字符串
+ * @example
+ * prefixClassName('pisell-procedure', 'header')
+ * // => 'pisell-procedure-header'
+ */
+export declare const prefixClassName: (prefix: string, suffix?: string) => string;
+/**
+ * 生成带修饰符的 BEM 类名
+ * @param block 块名
+ * @param modifier 修饰符
+ * @returns 类名字符串
+ * @example
+ * modifierClassName('pisell-procedure-footer', 'float-sidebar')
+ * // => 'pisell-procedure-footer--float-sidebar'
+ */
+export declare const modifierClassName: (block: string, modifier?: string) => string;