@pisell/materials 1.8.1 → 1.8.2

package/es/components/PisellProcedure/components/FooterActions.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+/**
+ * FooterActions 底部操作区组件 Props
+ */
+export interface FooterActionsProps {
+    /** 左侧插槽（自定义内容） */
+    leftSlot?: React.ReactNode;
+    /** 操作按钮插槽（右侧按钮组） */
+    children?: React.ReactNode;
+    /** 自定义类名 */
+    className?: string;
+    /** More 按钮文案 */
+    moreText?: string;
+    /** 按钮间距 */
+    gap?: number;
+}
+/**
+ * FooterActions 底部操作区组件
+ * @description 实现底部操作区的左右布局：左侧自定义内容 + 右侧操作按钮（支持溢出收纳）
+ * 收纳规则：从左到右依次收纳（优先级低的先收纳），保留右侧的主要操作按钮
+ * @author Pisell Team
+ */
+declare const FooterActions: React.FC<FooterActionsProps>;
+export default FooterActions;

package/es/components/PisellProcedure/components/ProcedureContent.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import type { CSSProperties, ReactNode } from 'react';
+/**
+ * ProcedureContent 子组件 Props
+ */
+export interface ProcedureContentProps {
+    /** 内容区类名 */
+    className?: string;
+    /** 内容区样式 */
+    style?: CSSProperties;
+    /** 内容区插槽 */
+    children?: ReactNode;
+    /** 额外内容（如底部操作区） */
+    extra?: ReactNode;
+}
+/**
+ * ProcedureContent 内容区组件
+ *
+ * @description 流程容器的主要内容展示区域
+ * @author Pisell Team
+ */
+declare const ProcedureContent: React.FC<ProcedureContentProps>;
+export default ProcedureContent;

package/es/components/PisellProcedure/components/ProcedureFooter.d.ts

@@ -0,0 +1,38 @@
+import React from 'react';
+import type { ProcedureFooterProps as FooterProps, FooterPositionMode, ProcedureMode } from '../types';
+import type { ReactNode } from 'react';
+/**
+ * ProcedureFooter 子组件 Props
+ */
+export interface ProcedureFooterProps {
+    /** 底部配置 */
+    footerProps?: FooterProps;
+    /** 底部位置模式 */
+    position: FooterPositionMode;
+    /** 自定义类名 */
+    className?: string;
+    /** 是否作为全局底部（使用 PisellFooter 包裹） */
+    isGlobal?: boolean;
+    /** 信息区内容（用于移动端弹窗展示） */
+    sidebarContent?: ReactNode;
+    /** 移动端弹窗是否打开（受控） */
+    summaryModalOpen?: boolean;
+    /** 打开移动端弹窗 */
+    onOpenSummaryModal?: () => void;
+    /** 关闭移动端弹窗 */
+    onCloseSummaryModal?: () => void;
+    /** 上一步回调 */
+    goPrev?: () => void;
+    /** 下一步回调 */
+    goNext?: () => void;
+    /** 组件使用模式 */
+    mode?: ProcedureMode;
+}
+/**
+ * ProcedureFooter 底部操作区组件
+ *
+ * @description 包含左侧自定义内容和右侧操作按钮（支持溢出收纳功能）
+ * @author Pisell Team
+ */
+declare const ProcedureFooter: React.FC<ProcedureFooterProps>;
+export default ProcedureFooter;

package/es/components/PisellProcedure/components/ProcedureHeader.d.ts

@@ -0,0 +1,34 @@
+import React from 'react';
+import type { ProcedureHeaderProps as HeaderProps } from '../types';
+export declare type ActionType = 'cancel' | 'ok' | 'confirm';
+/**
+ * ProcedureHeader 子组件 Props
+ */
+export interface ProcedureHeaderProps {
+    /** 头部配置 */
+    headerProps?: HeaderProps;
+    /** 当前步骤索引 */
+    currentStep: number;
+    /** 自定义类名 */
+    className?: string;
+    /** 上一步回调 */
+    goPrev?: () => void;
+    /** 跳转到指定步骤 */
+    goToStep?: (step: number) => void;
+    /** 关闭回调 */
+    onClose?: () => void;
+    /** 首步返回回调 */
+    onFirstStepBack?: () => void;
+    /** 返回确认回调 */
+    onBackConfirm?: (action: ActionType) => void;
+    /** 关闭确认回调 */
+    onCloseConfirm?: (action: ActionType) => void;
+}
+/**
+ * ProcedureHeader 头部区域组件
+ *
+ * @description 包含左侧返回按钮、中间步骤条、右侧关闭按钮
+ * @author Pisell Team
+ */
+declare const ProcedureHeader: React.FC<ProcedureHeaderProps>;
+export default ProcedureHeader;

package/es/components/PisellProcedure/components/ProcedureSidebar.d.ts

@@ -0,0 +1,38 @@
+import React from 'react';
+import type { CSSProperties, ReactNode } from 'react';
+import type { ProcedureMode, BodyDirection } from '../types';
+/**
+ * ProcedureSidebar 子组件 Props
+ */
+export interface ProcedureSidebarProps {
+    /** 信息区类名 */
+    className?: string;
+    /** 信息区样式 */
+    style?: CSSProperties;
+    /** 信息区插槽 */
+    children?: ReactNode;
+    /** 额外内容（如底部操作区） */
+    extra?: ReactNode;
+    /** 是否为比例布局模式 */
+    isRatioMode?: boolean;
+    /**
+     * 容器元素选择器（类名或 ID）
+     * @description 用于计算高度的容器元素，支持类名（如 '.modal-container'）或 ID（如 '#dialog-container'）
+     * @description 如果不提供，则使用 window.innerHeight 作为基准
+     */
+    containerSelector?: string;
+    /** 组件使用模式 */
+    mode?: ProcedureMode;
+    /** 排列方向 */
+    direction?: BodyDirection;
+    containerSize?: any;
+    responsiveClsComputed?: string;
+}
+/**
+ * ProcedureSidebar 信息区组件
+ *
+ * @description 流程容器的信息区（侧边栏），用于展示摘要信息
+ * @author Pisell Team
+ */
+declare const ProcedureSidebar: React.FC<ProcedureSidebarProps>;
+export default ProcedureSidebar;

package/es/components/PisellProcedure/hooks/index.d.ts

@@ -0,0 +1,8 @@
+export { useStepManager } from './useStepManager';
+export type { UseStepManagerOptions, UseStepManagerReturn, } from './useStepManager';
+export { useElementSize } from './useElementSize';
+export type { UseElementSizeOptions, ElementSize, } from './useElementSize';
+export { useOverflowActions } from './useOverflowActions';
+export type { UseOverflowActionsOptions, UseOverflowActionsReturn, } from './useOverflowActions';
+export { useSidebarHeight } from './useSidebarHeight';
+export { useResponsiveClass } from './useResponsiveClass';

package/es/components/PisellProcedure/hooks/useElementSize.d.ts

@@ -0,0 +1,38 @@
+/**
+ * useElementSize Hook 配置
+ */
+export interface UseElementSizeOptions {
+    /** 元素选择器（类名、ID 或其他 CSS 选择器） */
+    selector: string;
+    /** 是否启用监听（默认 true） */
+    enabled?: boolean;
+    /** 默认宽度（元素不存在时使用） */
+    defaultWidth?: number;
+    /** 默认高度（元素不存在时使用） */
+    defaultHeight?: number;
+    /** 尺寸变化阈值（像素），只有变化超过此值才更新（默认 1px） */
+    threshold?: number;
+    /** 防抖延迟时间（毫秒），默认 100ms */
+    debounceMs?: number;
+}
+/**
+ * 元素尺寸信息
+ */
+export interface ElementSize {
+    width: number;
+    height: number;
+}
+/**
+ * 元素尺寸计算 Hook（宽度和高度）
+ *
+ * @description 计算指定元素的宽度和高度，并监听尺寸变化自动更新
+ * 使用 ResizeObserver 和防抖机制优化性能，减少不必要的更新
+ *
+ * @example
+ * const { width, height } = useElementSize({
+ *   selector: '.modal-container',
+ *   defaultWidth: 0,
+ *   defaultHeight: 0
+ * });
+ */
+export declare const useElementSize: ({ selector, enabled, defaultWidth, defaultHeight, debounceMs, }: UseElementSizeOptions) => ElementSize;

package/es/components/PisellProcedure/hooks/useOverflowActions.d.ts

@@ -0,0 +1,43 @@
+import React from 'react';
+import type { MenuProps } from 'antd';
+/**
+ * useOverflowActions Hook 配置
+ */
+export interface UseOverflowActionsOptions {
+    /** 操作按钮子元素 */
+    children?: React.ReactNode;
+    /** 按钮间距 */
+    gap?: number;
+    /** More 按钮文案 */
+    moreText?: string;
+}
+/**
+ * useOverflowActions Hook 返回值
+ */
+export interface UseOverflowActionsReturn {
+    /** 容器 ref */
+    containerRef: React.RefObject<HTMLDivElement>;
+    /** 测量容器 ref */
+    measureRef: React.RefObject<HTMLDivElement>;
+    /** More 按钮测量 ref */
+    moreButtonRef: React.RefObject<HTMLDivElement>;
+    /** 左侧插槽 ref（用于测量宽度） */
+    leftSlotRef: React.RefObject<HTMLDivElement>;
+    /** 所有操作项 */
+    actionItems: React.ReactNode[];
+    /** 可见的操作项 */
+    visibleActions: React.ReactNode[];
+    /** 溢出的操作项 */
+    overflowActions: React.ReactNode[];
+    /** 是否有溢出 */
+    hasOverflow: boolean;
+    /** More 菜单项 */
+    moreMenuItems: MenuProps['items'];
+    /** 可用宽度（用于调试） */
+    availableWidth: number;
+}
+/**
+ * 溢出收纳 Hook
+ * @description 处理操作按钮的溢出收纳逻辑，支持左侧自定义内容
+ */
+export declare const useOverflowActions: (options: UseOverflowActionsOptions) => UseOverflowActionsReturn;

package/es/components/PisellProcedure/hooks/useResponsiveClass.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 使用响应式类名的 Hook
+ *
+ * @description 根据容器宽度计算响应式类名，延迟应用以避免宽度抖动
+ */
+export declare const useResponsiveClass: (containerWidth: number) => string;

package/es/components/PisellProcedure/hooks/useSidebarHeight.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 尺寸值接口
+ */
+interface SizeValues {
+    containerSelector?: string;
+    containerHeight?: number;
+    headerHeight?: number;
+    footerHeight: number;
+}
+/**
+ * 使用 Sidebar 高度的 Hook
+ *
+ * @description 计算并管理 Sidebar 的高度，确保在尺寸稳定后才应用
+ */
+export declare const useSidebarHeight: (isSizeStable: boolean, sizeValues: SizeValues) => number | undefined;
+export {};

package/es/components/PisellProcedure/hooks/useStepManager.d.ts

@@ -0,0 +1,50 @@
+import type { StepChangeResult } from '../types';
+import type { PisellStepsProps } from '../../PisellSteps/types';
+/**
+ * useStepManager Hook 配置
+ */
+export interface UseStepManagerOptions {
+    /** 步骤条配置 */
+    stepsProps?: PisellStepsProps;
+    /** 初始步骤索引 */
+    defaultCurrent?: number;
+    /** 上一步事件回调 */
+    onPrev?: (current: number) => boolean | void;
+    /** 下一步事件回调 */
+    onNext?: (current: number) => boolean | void;
+    /** 步骤变化回调 */
+    onStepsChange?: (result: StepChangeResult) => void;
+    /** 跳转到指定步骤 */
+    goToStep?: (step: number) => void;
+}
+/**
+ * useStepManager Hook 返回值
+ */
+export interface UseStepManagerReturn {
+    /** 当前步骤索引 */
+    currentStep: number;
+    /** 步骤列表 */
+    items: any[];
+    /** 步骤总数 */
+    totalSteps: number;
+    /** 上一步 */
+    goPrev: () => StepChangeResult | null;
+    /** 下一步 */
+    goNext: () => StepChangeResult | null;
+    /** 跳转到指定步骤 */
+    goToStep: (step: number) => StepChangeResult | null;
+}
+/**
+ * 步骤管理 Hook
+ *
+ * @description 管理多步骤流程的状态和操作
+ * @example
+ * const { currentStep, goPrev, goNext } = useStepManager({
+ *   stepsProps: { items: [...] },
+ *   defaultCurrent: 0,
+ *   onPrev: (current) => { ... },
+ *   onNext: (current) => { ... },
+ *   onStepsChange: (result) => { ... },
+ * });
+ */
+export declare const useStepManager: ({ stepsProps, defaultCurrent, onPrev, onNext, onStepsChange, }: UseStepManagerOptions) => UseStepManagerReturn;

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

@@ -0,0 +1,363 @@
+import type { CSSProperties, ReactNode } from 'react';
+import type { PisellStepsProps } from '../PisellSteps/types';
+/**
+ * 步骤项数据
+ */
+export interface StepItem {
+    /** 步骤索引 */
+    index?: number;
+    /** 步骤标题 */
+    title?: ReactNode;
+    /** 步骤描述 */
+    description?: ReactNode;
+    /** 其他数据 */
+    [key: string]: any;
+}
+/**
+ * 步骤变化结果
+ */
+export interface StepChangeResult {
+    /** 是否成功 */
+    success: boolean;
+    /** 当前步骤索引 */
+    currentStep: number;
+    /** 当前步骤数据 */
+    currentItem: StepItem | null;
+}
+/**
+ * PisellProcedure Ref 暴露的方法
+ * @description 通过 ref 可以调用的组件方法
+ */
+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 BackConfirmModalConfig {
+    /**
+     * 是否启用返回确认弹窗
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * 弹窗标题
+     * @description 支持字符串格式
+     */
+    title?: string;
+    /**
+     * 弹窗描述内容
+     * @description 支持字符串格式
+     */
+    describe?: string;
+    /**
+     * 弹窗底部插槽
+     * @description 底部按钮区域，支持放置任意内容
+     */
+    footer?: ReactNode;
+}
+/**
+ * 头部插槽顺序
+ */
+export declare type HeaderSlotOrder = 'default' | 'reverse';
+/**
+ * ProcedureHeader 头部区域配置
+ */
+export interface ProcedureHeaderProps {
+    /** 自定义类名 */
+    className?: string;
+    /** 自定义样式 */
+    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;
+}
+/**
+ * 主体区域布局模式
+ */
+export declare type BodyLayoutMode = 'fixed' | 'ratio';
+/**
+ * 内容区与信息区的比例配置
+ * @example '7:3' | '6:4'
+ */
+export declare type BodyLayoutRatio = `${number}:${number}`;
+/**
+ * 主体区域排列方向
+ */
+export declare type BodyDirection = 'horizontal' | 'vertical';
+/**
+ * 主体区域内容顺序
+ */
+export declare type BodyContentOrder = 'content-first' | 'sidebar-first';
+/**
+ * ProcedureBody 主体区域配置
+ */
+export interface ProcedureBodyProps {
+    /** 自定义类名 */
+    className?: string;
+    /** 自定义样式 */
+    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 declare type FooterPositionMode = 'fixed-bottom' | 'fixed-content-bottom' | 'fixed-sidebar-bottom' | 'float-all' | 'float-content' | 'float-sidebar';
+/**
+ * ProcedureFooter 底部区域配置
+ */
+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 declare type ProcedureMode = 'page' | 'modal';
+/**
+ * PisellProcedure 组件 Props
+ * @description 流程容器组件，用于管理多步骤流程的复合容器
+ */
+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>;
+}