@pisell/materials 6.11.10 → 6.11.11

package/es/components/PisellCards/components/PisellImageCard/hooks/useImageLoad.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 图片加载状态管理 Hook
+ * @param src - 图片地址
+ * @param lazy - 是否启用懒加载
+ * @returns 加载状态对象
+ */
+export declare const useImageLoad: (src?: string, lazy?: boolean) => {
+    loading: boolean;
+    error: boolean;
+    imgRef: import("react").RefObject<HTMLImageElement>;
+};

package/es/components/PisellCards/components/PisellImageCard/hooks/usePisellImageCardStyle.d.ts

@@ -0,0 +1,10 @@
+import { PisellImageCardProps } from '../types';
+/**
+ * 样式合并 Hook
+ * @param props - 组件 Props
+ * @returns 合并后的样式和类名
+ */
+export declare const usePisellImageCardStyle: (props: PisellImageCardProps) => {
+    mergedStyle: React.CSSProperties;
+    mergedClassName: string;
+};

package/es/components/PisellCards/components/PisellImageCard/types.d.ts

@@ -0,0 +1,74 @@
+import { CSSProperties } from 'react';
+import { PisellBasicCardProps } from '../../types';
+/**
+ * 图片填充模式类型
+ */
+export declare type ImageFillMode = 'cover' | 'contain' | 'fill' | 'none';
+/**
+ * 图片数据源配置
+ */
+export interface ImageDataSource {
+    /**
+     * 图片地址
+     * 支持相对路径和绝对路径
+     */
+    src?: string;
+    /**
+     * 图片替换文本
+     * 当图片未设置或加载失败时，显示 alt 的前 2 个字符
+     */
+    alt?: string;
+    /**
+     * 图片加载失败后的兜底图地址
+     */
+    errorSrc?: string;
+    /**
+     * 首次加载时的占位图地址
+     */
+    fallbackSrc?: string;
+    text?: string;
+}
+/**
+ * PisellImageCard 组件 Props
+ * 基于 PisellBasicCardProps 扩展
+ * 注意：重写 onClick 为可选属性
+ */
+export interface PisellImageCardProps extends Omit<PisellBasicCardProps, 'onClick'> {
+    /**
+     * 图片数据源配置
+     */
+    dataSource?: ImageDataSource;
+    /**
+     * 图片填充模式
+     * - cover: 覆盖容器，保持比例，可能裁剪
+     * - contain: 完整显示，保持比例，可能留白
+     * - fill: 拉伸填充，不保持比例
+     * - none: 原始尺寸，不缩放
+     * @default 'cover'
+     */
+    fillMode?: ImageFillMode;
+    /**
+     * 图片宽度
+     * 支持任意 CSS 合法值（px、%、rem 等）
+     * @default '100%'
+     */
+    width?: CSSProperties['width'];
+    aliWidth?: number;
+    /**
+     * 图片高度
+     * 支持任意 CSS 合法值（px、%、rem 等）
+     * @default '100%'
+     */
+    height?: CSSProperties['height'];
+    /**
+     * 是否启用图片懒加载
+     * 仅当图片进入视口时才加载
+     * @default false
+     */
+    lazy?: boolean;
+    /**
+     * 点击事件
+     * 注意：PisellBasicCardProps 中的 onClick 是必填的，这里重新定义为可选
+     */
+    onClick?: (e: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
+}

package/es/components/PisellCards/components/PisellImageCard/utils/getImageObjectFit.d.ts

@@ -0,0 +1,7 @@
+import { ImageFillMode } from '../types';
+/**
+ * 根据填充模式获取对应的 CSS object-fit 值
+ * @param fillMode - 填充模式
+ * @returns CSS object-fit 值
+ */
+export declare const getImageObjectFit: (fillMode?: ImageFillMode) => string;

package/es/components/PisellCards/components/PisellImageCard/utils/getTruncatedText.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 截取文本前 N 个字符
+ * @param text - 原始文本
+ * @param maxLength - 最大长度，默认 2
+ * @returns 截取后的文本
+ */
+export declare const getTruncatedText: (text?: string, maxLength?: number) => string;

package/es/components/PisellCards/components/PisellImageCard/utils/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * PisellImageCard 工具函数导出
+ */
+export { getImageObjectFit } from './getImageObjectFit';
+export { getTruncatedText } from './getTruncatedText';

package/es/components/PisellCards/components/TabCard/TabCard.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import './TabCard.less';
+declare const Provider: (props: any) => React.JSX.Element;
+export default Provider;

package/es/components/PisellCards/components/TabCard/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * TabCard 标签卡片组件
+ */
+export { default } from './TabCard';
+export type { TabCardProps, BadgeConfig } from './types';

package/es/components/PisellCards/components/TabCard/types.d.ts

@@ -0,0 +1,70 @@
+import { ReactNode } from 'react';
+import { PisellBasicCardProps } from '../../types';
+/**
+ * 徽章配置
+ */
+export interface BadgeConfig {
+    /**
+     * 徽章数字或文本
+     */
+    count?: number | string;
+    /**
+     * 是否显示小红点
+     */
+    dot?: boolean;
+    /**
+     * 徽章颜色
+     */
+    color?: string;
+    /**
+     * 徽章偏移位置 [x, y]
+     */
+    offset?: [number, number];
+}
+/**
+ * TabCard 组件 Props
+ * 基于 PisellBasicCardProps 扩展
+ */
+export interface TabCardProps extends PisellBasicCardProps {
+    /**
+     * 标签唯一标识
+     * 必填，用于标识标签
+     */
+    tabKey: string | number;
+    /**
+     * 标签文本
+     * 必填
+     */
+    label: ReactNode;
+    /**
+     * 标签图标
+     * 可选，支持 ReactNode（如 antd Icon）
+     */
+    icon?: ReactNode;
+    /**
+     * 徽章配置
+     * 可选，用于显示未读数、状态等
+     */
+    badge?: BadgeConfig;
+    /**
+     * 点击事件
+     * 点击标签时触发，传递 tabKey 和事件对象
+     */
+    onClick?: (tabKey: string | number, event: React.MouseEvent) => void;
+    /**
+     * 标签位置
+     * 用于控制图标和文本的布局方向
+     * @default 'horizontal'
+     */
+    direction?: 'horizontal' | 'vertical';
+    /**
+     * 标签尺寸
+     * @default 'medium'
+     */
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * 自定义渲染
+     * 完全自定义标签内容
+     */
+    render?: (props: TabCardProps) => ReactNode;
+}

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

@@ -0,0 +1,48 @@
+import { CSSProperties, ReactNode } from 'react';
+/**
+ * 基础卡片 Props 定义
+ * 所有业务卡片都应该基于此 Props 进行扩展
+ * 注意：这只是类型定义，不是实体组件
+ */
+export interface PisellBasicCardProps extends React.HTMLAttributes<HTMLDivElement> {
+    __designMode?: boolean;
+    dataSource?: any;
+    /**
+     * 激活状态配置
+     * 用于标识卡片是否处于激活/选中状态
+     */
+    active?: {
+        value: boolean;
+        style?: CSSProperties;
+        className?: string;
+        onChange?: (value: boolean) => void;
+        extra?: any;
+    };
+    /**
+     * 禁用状态配置
+     * 用于标识卡片是否处于禁用状态
+     */
+    disabled?: {
+        value: boolean;
+        style?: CSSProperties;
+        className?: string;
+        onChange?: (value: boolean) => void;
+        extra?: any;
+    };
+    /**
+     * 加载状态配置
+     * 用于标识卡片是否处于加载状态
+     */
+    loading?: {
+        value: boolean;
+        style?: CSSProperties;
+        className?: string;
+        onChange?: (value: boolean) => void;
+        extra?: any;
+    };
+    /**
+     * 卡片内容
+     */
+    children?: ReactNode;
+    onClick: (e: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
+}

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

@@ -0,0 +1,22 @@
+import React from 'react';
+import type { PisellProcedureProps, PisellProcedureRef } from './types';
+import './PisellProcedure.less';
+/**
+ * PisellProcedure 流程容器组件
+ *
+ * @description 用于管理多步骤流程的复合容器组件，基于 PisellLayout 实现三段式布局
+ * @author Pisell Team
+ * @version 1.0.0
+ *
+ * @example
+ * // 使用 ref 调用组件方法
+ * const procedureRef = useRef<PisellProcedureRef>(null);
+ *
+ * // 跳转到下一步
+ * procedureRef.current?.goNext();
+ *
+ * // 获取当前步骤
+ * const currentStep = procedureRef.current?.getCurrentStep();
+ */
+declare const PisellProcedure: React.ForwardRefExoticComponent<PisellProcedureProps & React.RefAttributes<PisellProcedureRef>>;
+export default PisellProcedure;

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

@@ -0,0 +1,41 @@
+import React from 'react';
+import type { ProcedureBodyProps as BodyProps, ProcedureFooterProps, FooterPositionMode, ProcedureMode } from '../types';
+/**
+ * ProcedureBody 子组件 Props
+ */
+export interface ProcedureBodyProps {
+    /** 主体配置 */
+    bodyProps?: BodyProps;
+    /** 底部配置 */
+    footerProps?: ProcedureFooterProps;
+    /** 底部位置模式 */
+    footerPosition: FooterPositionMode;
+    /** 是否显示底部 */
+    showFooter?: boolean;
+    /** 是否显示信息区 */
+    showSidebar?: boolean;
+    /** 自定义类名 */
+    className?: string;
+    /** 移动端弹窗是否打开 */
+    summaryModalOpen?: boolean;
+    /** 打开移动端弹窗 */
+    onOpenSummaryModal?: () => void;
+    /** 关闭移动端弹窗 */
+    onCloseSummaryModal?: () => void;
+    /** 上一步回调 */
+    goPrev?: () => void;
+    /** 下一步回调 */
+    goNext?: () => void;
+    /** 组件使用模式 */
+    mode?: ProcedureMode;
+    containerSize?: any;
+    responsiveClsComputed?: string;
+}
+/**
+ * ProcedureBody 主体区域组件
+ *
+ * @description 包含内容区和信息区的布局容器，支持固定宽度和比例两种布局模式
+ * @author Pisell Team
+ */
+declare const ProcedureBody: React.FC<ProcedureBodyProps>;
+export default ProcedureBody;

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

@@ -0,0 +1,12 @@
+export { default as FooterActions } from './FooterActions';
+export type { FooterActionsProps } from './FooterActions';
+export { default as ProcedureHeader } from './ProcedureHeader';
+export type { ProcedureHeaderProps } from './ProcedureHeader';
+export { default as ProcedureBody } from './ProcedureBody';
+export type { ProcedureBodyProps } from './ProcedureBody';
+export { default as ProcedureContent } from './ProcedureContent';
+export type { ProcedureContentProps } from './ProcedureContent';
+export { default as ProcedureSidebar } from './ProcedureSidebar';
+export type { ProcedureSidebarProps } from './ProcedureSidebar';
+export { default as ProcedureFooter } from './ProcedureFooter';
+export type { ProcedureFooterProps } from './ProcedureFooter';

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';