@pisell/materials 6.3.26 → 6.3.28

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

@@ -0,0 +1,163 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import PisellProcedure from './PisellProcedure';
+/**
+ * PisellProcedure 流程容器组件
+ *
+ * 用于管理多步骤流程的复合容器组件，基于 PisellLayout 实现三段式布局
+ * 包含头部区域（步骤条）、主体区域（内容区+信息区）、底部区域（操作按钮）
+ */
+declare const meta: Meta<typeof PisellProcedure>;
+export default meta;
+declare type Story = StoryObj<typeof PisellProcedure>;
+/**
+ * 基础用法
+ * @description 默认流程容器，包含头部、主体、底部三个区域
+ */
+export declare const Default: Story;
+/**
+ * 页面模式
+ * @description 默认模式，支持响应式和移动端适配
+ */
+export declare const PageMode: Story;
+/**
+ * 弹窗模式
+ * @description 用于弹窗场景，不应用移动端适配
+ */
+export declare const ModalMode: Story;
+/**
+ * 步骤控制
+ * @description 使用 onStepsChange 监听步骤变化
+ */
+export declare const StepControl: Story;
+/**
+ * 步骤拦截
+ * @description 通过 onNext/onPrev 返回 false 阻止步骤切换
+ */
+export declare const StepIntercept: Story;
+/**
+ * 无侧边栏
+ */
+export declare const WithoutSidebar: Story;
+/**
+ * 无头部
+ */
+export declare const WithoutHeader: Story;
+/**
+ * 无底部
+ */
+export declare const WithoutFooter: Story;
+/**
+ * 最小配置
+ * @description 仅显示主体内容
+ */
+export declare const MinimalConfig: Story;
+/**
+ * 头部插槽顺序 - 默认
+ * @description left 在左，right 在右
+ */
+export declare const HeaderSlotDefault: Story;
+/**
+ * 头部插槽顺序 - 反转
+ * @description left 在右，right 在左
+ */
+export declare const HeaderSlotReverse: Story;
+/**
+ * 隐藏步骤条
+ * @description 仅显示头部插槽，不显示步骤条
+ */
+export declare const HideSteps: Story;
+/**
+ * 第一步显示返回按钮
+ * @description 通过 showBackOnFirstStep 控制
+ */
+export declare const ShowBackOnFirstStep: Story;
+/**
+ * 返回确认弹窗
+ * @description 点击返回时弹出确认弹窗
+ */
+export declare const BackConfirmModal: Story;
+/**
+ * 关闭确认弹窗
+ * @description 点击关闭时弹出确认弹窗
+ */
+export declare const CloseConfirmModal: Story;
+/**
+ * 主体布局 - 比例布局
+ * @description 使用比例分配内容区和侧边栏宽度
+ */
+export declare const BodyRatioLayout: Story;
+/**
+ * 主体布局 - 固定宽度
+ * @description 侧边栏使用固定宽度
+ */
+export declare const BodyFixedLayout: Story;
+/**
+ * 主体布局 - 垂直布局
+ * @description 内容区和侧边栏上下排列
+ */
+export declare const BodyVerticalLayout: Story;
+/**
+ * 主体布局 - 内容顺序反转
+ * @description 侧边栏在左/上，内容区在右/下
+ */
+export declare const BodyContentOrderReverse: Story;
+/**
+ * 底部位置 - 悬浮在侧边栏
+ * @description 默认位置，底部悬浮在侧边栏区域
+ */
+export declare const FooterFloatSidebar: Story;
+/**
+ * 底部位置 - 固定在整体底部
+ */
+export declare const FooterFixedBottom: Story;
+/**
+ * 底部位置 - 悬浮在整体区域
+ * @description 移动端默认使用此模式
+ */
+export declare const FooterFloatAll: Story;
+/**
+ * 底部位置 - 悬浮在内容区
+ */
+export declare const FooterFloatContent: Story;
+/**
+ * 底部位置 - 内嵌在内容区底部
+ */
+export declare const FooterFixedContentBottom: Story;
+/**
+ * 底部位置 - 内嵌在侧边栏底部
+ */
+export declare const FooterFixedSidebarBottom: Story;
+/**
+ * 移动端总结按钮
+ * @description 移动端显示总结按钮，点击可查看侧边栏内容
+ */
+export declare const MobileSummaryButton: Story;
+/**
+ * 溢出收纳功能
+ * @description 当宽度不足时，按钮会被收纳到 More 菜单中
+ */
+export declare const OverflowActions: Story;
+/**
+ * 禁用溢出收纳
+ * @description 不启用溢出收纳，按钮会换行显示
+ */
+export declare const DisableOverflow: Story;
+/**
+ * 完整示例 - 购物流程
+ * @description 模拟真实的购物流程
+ */
+export declare const ShoppingFlow: Story;
+/**
+ * 完整示例 - 注册流程
+ * @description 模拟用户注册流程
+ */
+export declare const RegistrationFlow: Story;
+/**
+ * 完整示例 - 表单向导
+ * @description 多步表单向导
+ */
+export declare const FormWizard: Story;
+/**
+ * 交互测试 - 组件渲染
+ */
+export declare const InteractionTest: Story;

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/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/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * PisellProcedure 组件导出
+ */
+export { default } from './PisellProcedure';
+export type { PisellProcedureProps, PisellProcedureRef, ProcedureHeaderProps, ProcedureBodyProps, ProcedureFooterProps, FooterPositionMode, BackConfirmModalConfig, BodyLayoutMode, BodyLayoutRatio, BodyDirection, StepItem, StepChangeResult, } from './types';