@pisell/materials 1.8.14 → 1.8.15

package/lib/components/PisellCards/components/TextCard/types.d.ts

@@ -0,0 +1,270 @@
+import { CSSProperties, ReactNode } from 'react';
+import { PisellBasicCardProps } from '../../types';
+/**
+ * 样式变体类型
+ */
+export declare type TextCardVariant = 'text' | 'filled' | 'outlined' | 'light' | 'gradient' | 'dashed';
+/**
+ * 尺寸类型
+ */
+export declare type TextCardSize = 'small' | 'default' | 'large';
+/**
+ * 宽度模式
+ */
+export declare type TextCardWidthMode = 'auto' | 'fixed' | 'full';
+/**
+ * 图标配置
+ */
+export interface IconConfig {
+    /**
+     * 图标大小（单位：px）
+     */
+    size?: number;
+    /**
+     * 图标颜色
+     */
+    color?: string;
+}
+/**
+ * 标签配置
+ */
+export interface TagConfig {
+    /**
+     * 标签颜色
+     */
+    color?: string;
+    /**
+     * 标签自定义样式
+     */
+    style?: CSSProperties;
+}
+/**
+ * 角标类型
+ */
+export declare type BadgeType = 'dot' | 'number' | 'text';
+/**
+ * 角标位置
+ */
+export declare type BadgePosition = 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
+/**
+ * 角标配置
+ */
+export interface BadgeConfig {
+    /**
+     * 角标类型
+     * @default 'dot'
+     */
+    type?: BadgeType;
+    /**
+     * 角标内容（数字或文本）
+     * 当 type 为 'number' 或 'text' 时有效
+     */
+    content?: ReactNode;
+    /**
+     * 角标位置
+     * @default 'top-right'
+     */
+    position?: BadgePosition;
+    /**
+     * 角标偏移量 [x, y]
+     * 正数向右/下偏移，负数向左/上偏移
+     */
+    offset?: [number, number];
+    /**
+     * 角标颜色
+     */
+    color?: string;
+    /**
+     * 角标自定义样式
+     */
+    style?: CSSProperties;
+}
+/**
+ * 文本配置
+ */
+export interface TextConfig {
+    /**
+     * 字体大小（单位：px）
+     */
+    fontSize?: number;
+    /**
+     * 字体粗细
+     */
+    fontWeight?: string | number;
+    /**
+     * 文本颜色
+     */
+    color?: string;
+    /**
+     * 最大显示行数
+     * @default 1
+     */
+    maxLines?: number;
+    /**
+     * 是否显示省略号
+     * @default true
+     */
+    ellipsis?: boolean;
+    /**
+     * 文本对齐方式
+     * @default 'left'
+     */
+    textAlign?: 'left' | 'center' | 'right';
+    flex?: string;
+}
+/**
+ * TextCard 组件 Props
+ * 基于 PisellBasicCardProps 扩展
+ * 注意：重写 onClick 为可选属性
+ */
+export interface TextCardProps extends Omit<PisellBasicCardProps, 'onClick'> {
+    /**
+     * 卡片显示的文本内容（必填）
+     */
+    text: ReactNode;
+    /**
+     * 卡片样式变体
+     * @default 'text'
+     */
+    variant?: TextCardVariant;
+    /**
+     * 卡片尺寸
+     * @default 'default'
+     */
+    size?: TextCardSize;
+    /**
+     * 是否可点击
+     * @default true
+     */
+    clickable?: boolean;
+    /**
+     * 前置图标
+     * 支持 ReactNode（如 antd Icon、svg 等）
+     */
+    prefixIcon?: ReactNode;
+    /**
+     * 后置图标
+     * 支持 ReactNode（如 antd Icon、svg 等）
+     */
+    suffixIcon?: ReactNode;
+    /**
+     * 图标配置
+     * 统一配置前置和后置图标的大小和颜色
+     */
+    iconConfig?: IconConfig;
+    /**
+     * 后置标签
+     * 支持 ReactNode（如 antd Tag、Badge 等）
+     */
+    tag?: ReactNode;
+    /**
+     * 标签配置
+     */
+    tagConfig?: TagConfig;
+    /**
+     * 角标配置
+     * 用于显示红点、数字或文本提示
+     */
+    badge?: BadgeConfig;
+    /**
+     * 前置插槽
+     * 用于替换前置图标，优先级高于 prefixIcon
+     */
+    prefixSlot?: ReactNode;
+    /**
+     * 后置插槽
+     * 用于替换后置图标和标签，优先级高于 suffixIcon 和 tag
+     */
+    suffixSlot?: ReactNode;
+    /**
+     * 文本配置
+     * 用于自定义文本样式和显示行为
+     */
+    textConfig?: TextConfig;
+    /**
+     * 宽度模式
+     * - auto: 内容撑满，最大宽度 maxWidth
+     * - fixed: 固定宽度 width
+     * - full: 撑满父容器，最小宽度 28px
+     * @default 'auto'
+     */
+    widthMode?: TextCardWidthMode;
+    /**
+     * 固定宽度值
+     * 当 widthMode='fixed' 时有效
+     */
+    width?: number | string;
+    /**
+     * 最大宽度
+     * 当 widthMode='auto' 时有效
+     * @default 400
+     */
+    maxWidth?: number | string;
+    /**
+     * 点击事件
+     * 当 clickable=true 且不在 disabled/loading 状态时触发
+     * 注意：PisellBasicCardProps 中的 onClick 是必填的，这里重新定义为可选
+     */
+    onClick?: (event: React.MouseEvent<HTMLDivElement>) => void;
+    /**
+     * 自定义渲染函数
+     * 完全自定义组件的渲染内容
+     * 当提供此函数时，组件内置的渲染逻辑将被忽略
+     */
+    render?: (props: TextCardProps) => ReactNode;
+}
+/**
+ * TextContent 组件 Props
+ * 文本内容子组件
+ */
+export interface TextContentProps {
+    /**
+     * 文本内容
+     */
+    text: ReactNode;
+    /**
+     * 文本配置
+     */
+    textConfig?: TextConfig;
+    /**
+     * 自定义类名
+     */
+    className?: string;
+    active?: PisellBasicCardProps['active'];
+}
+/**
+ * IconWrapper 组件 Props
+ * 图标包装子组件
+ */
+export interface IconWrapperProps {
+    /**
+     * 图标内容
+     */
+    icon: ReactNode;
+    /**
+     * 图标配置
+     */
+    config?: IconConfig;
+    /**
+     * 图标位置
+     */
+    position: 'prefix' | 'suffix';
+    /**
+     * 自定义类名
+     */
+    className?: string;
+}
+/**
+ * BadgeWrapper 组件 Props
+ * 角标包装子组件
+ */
+export interface BadgeWrapperProps {
+    /**
+     * 角标配置
+     */
+    badge?: BadgeConfig;
+    /**
+     * 子元素
+     */
+    children: ReactNode;
+}

package/lib/components/PisellCards/index.d.ts

@@ -1,10 +1,9 @@
-/// <reference types="react" />
 declare const PisellCards: {
-    TabCard: (props: any) => import("react").JSX.Element;
-    TextCard: (props: any) => import("react").JSX.Element;
-    GraphicTextCard: (props: import("./components/GraphicTextCard").GraphicTextCardProps) => import("react").JSX.Element;
-    MultilevelCard: (props: any) => import("react").JSX.Element;
-    PisellImageCard: (props: import("./components/PisellImageCard").PisellImageCardProps) => import("react").JSX.Element;
+    TabCard: (props: any) => JSX.Element;
+    TextCard: (props: any) => JSX.Element;
+    GraphicTextCard: (props: import("./components/GraphicTextCard").GraphicTextCardProps) => JSX.Element;
+    MultilevelCard: (props: any) => JSX.Element;
+    PisellImageCard: (props: import("./components/PisellImageCard").PisellImageCardProps) => JSX.Element;
 };
 export default PisellCards;
 export type { PisellBasicCardProps } from './types';

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

@@ -9,7 +9,6 @@
  * <PisellFields.Number value={123} viewMode="readonly" />
  * <PisellFields.Currency value={1000} currencySymbol="$" />
  */
-/// <reference types="react" />
 declare const PisellFields: {
     SingleLineText: import("react").NamedExoticComponent<import("../pisellSingleLineText").PisellSingleLineTextProps>;
     LongText: import("react").NamedExoticComponent<import("../pisellLongText").PisellLongTextProps>;

package/lib/components/PisellLayouts/index.d.ts

@@ -13,9 +13,8 @@
  *   <Content />
  * </PisellLayouts.ScrollView>
  */
-/// <reference types="react" />
 declare const PisellLayouts: {
-    BasicGrid: <T>(props: import("../PisellBasicGrid").PisellBasicGridProps<T>) => import("react").JSX.Element;
+    BasicGrid: <T>(props: import("../PisellBasicGrid").PisellBasicGridProps<T>) => JSX.Element;
     ScrollView: import("react").ForwardRefExoticComponent<Omit<import("../PisellScrollView").PisellScrollViewProps, "ref"> & import("react").RefAttributes<import("../PisellScrollView").PisellScrollViewRef>>;
     Layout: import("../pisellLayout").CompoundedComponent;
     Content: import("react").FC<import("../pisellLayout/content").PisellContentProps>;
@@ -23,7 +22,7 @@ declare const PisellLayouts: {
     Header: import("react").FC<import("../pisellLayout/header").PisellHeaderProps>;
     Sider: import("react").FC<import("../pisellLayout/sider").PisellSiderProps>;
     Container: <T_1 extends import("../pisellContainer").RenderType>(props: import("../pisellContainer").PisellContainerProps<T_1>) => any;
-    Row: (props: import("../pisellRow").PisellRowProps) => import("react").JSX.Element;
+    Row: (props: import("../pisellRow").PisellRowProps) => JSX.Element;
     ViewGrid: import("react").FC<import("../pisellViewGrid").PisellViewGridProps>;
 };
 export default PisellLayouts;

package/lib/components/PisellMetrics/index.d.ts

@@ -13,11 +13,10 @@
  * />
  * <PisellMetrics.StatisticList data={[...]} />
  */
-/// <reference types="react" />
 declare const PisellMetrics: {
     MetricCard: import("react").FC<import("../pisellMetricCard").PisellMetricCardProps>;
-    StatisticList: (props: import("../pisellStatisticList").PisellStatisticListProps) => import("react").JSX.Element;
-    MetricItem: (props: import("../cardMetricItem").PisellStatisticProps) => import("react").JSX.Element;
+    StatisticList: (props: import("../pisellStatisticList").PisellStatisticListProps) => JSX.Element;
+    MetricItem: (props: import("../cardMetricItem").PisellStatisticProps) => JSX.Element;
 };
 export default PisellMetrics;
 export type { PisellMetricCardProps } from '../pisellMetricCard';

package/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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;