@pisell/materials 1.8.6 → 1.8.8

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

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

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

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

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

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

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

@@ -0,0 +1,36 @@
+/**
+ * PisellFields 命名空间
+ * 字段组件集合 - 支持编辑态、只读态、禁用态三种视图模式
+ *
+ * @example
+ * import { PisellFields } from '@pisell/materials';
+ *
+ * <PisellFields.SingleLineText value="hello" viewMode="edit" />
+ * <PisellFields.Number value={123} viewMode="readonly" />
+ * <PisellFields.Currency value={1000} currencySymbol="$" />
+ */
+declare const PisellFields: {
+    SingleLineText: import("react").NamedExoticComponent<import("../pisellSingleLineText").PisellSingleLineTextProps>;
+    LongText: import("react").NamedExoticComponent<import("../pisellLongText").PisellLongTextProps>;
+    Number: import("react").NamedExoticComponent<import("../pisellNumber").PisellNumberProps>;
+    Currency: import("react").NamedExoticComponent<import("../pisellCurrency").PisellCurrencyProps>;
+    Percent: import("react").NamedExoticComponent<import("../pisellPercent").PisellPercentProps>;
+    Phone: import("react").NamedExoticComponent<import("../pisellPhone").PisellPhoneProps>;
+    Email: import("react").FC<import("../pisellEmail").PisellEmailProps>;
+    Url: import("react").FC<import("../pisellUrl").PisellUrlProps>;
+    Rating: import("react").NamedExoticComponent<import("../pisellRating").PisellRatingProps>;
+    SingleSelect: import("react").ForwardRefExoticComponent<import("../pisellSingleSelect").PisellSingleSelectProps<string | number> & import("react").RefAttributes<import("../pisellSingleSelect").SingleSelectRef<string | number>>>;
+    MultipleSelect: import("react").ForwardRefExoticComponent<import("../pisellMultipleSelect").PisellMultipleSelectProps<string | number> & import("react").RefAttributes<import("../pisellMultipleSelect").MultipleSelectRef<string | number>>>;
+};
+export default PisellFields;
+export type { PisellSingleLineTextProps, } from '../pisellSingleLineText';
+export type { PisellLongTextProps, } from '../pisellLongText';
+export type { PisellNumberProps, } from '../pisellNumber';
+export type { PisellCurrencyProps, } from '../pisellCurrency';
+export type { PisellPercentProps, } from '../pisellPercent';
+export type { PisellPhoneProps, CountryCode, } from '../pisellPhone';
+export type { PisellEmailProps, MailtoOptions, } from '../pisellEmail';
+export type { PisellUrlProps, } from '../pisellUrl';
+export type { PisellRatingProps, } from '../pisellRating';
+export type { PisellSingleSelectProps, SingleSelectRef, } from '../pisellSingleSelect';
+export type { PisellMultipleSelectProps, MultipleSelectRef, } from '../pisellMultipleSelect';

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

@@ -0,0 +1,32 @@
+/**
+ * PisellLayouts 命名空间
+ * 布局组件集合
+ *
+ * @example
+ * import { PisellLayouts } from '@pisell/materials';
+ *
+ * <PisellLayouts.BasicGrid columns={3} gap={16}>
+ *   {items.map(item => <Card key={item.id} {...item} />)}
+ * </PisellLayouts.BasicGrid>
+ *
+ * <PisellLayouts.ScrollView direction="horizontal">
+ *   <Content />
+ * </PisellLayouts.ScrollView>
+ */
+declare const PisellLayouts: {
+    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>;
+    Footer: import("react").FC<import("../pisellLayout/footer").PisellFooterProps>;
+    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) => JSX.Element;
+    ViewGrid: import("react").FC<import("../pisellViewGrid").PisellViewGridProps>;
+};
+export default PisellLayouts;
+export type { PisellBasicGridProps, } from '../PisellBasicGrid';
+export type { PisellScrollViewProps, } from '../PisellScrollView';
+export type { PisellLayoutProps, CompoundedComponent, } from '../pisellLayout';
+export type { PisellRowProps, } from '../pisellRow';

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

@@ -0,0 +1,23 @@
+/**
+ * PisellMetrics 命名空间
+ * 数据指标展示组件集合
+ *
+ * @example
+ * import { PisellMetrics } from '@pisell/materials';
+ *
+ * <PisellMetrics.MetricCard
+ *   title="Total Sales"
+ *   value={1580}
+ *   comparison={120}
+ *   showTrendIcon
+ * />
+ * <PisellMetrics.StatisticList data={[...]} />
+ */
+declare const PisellMetrics: {
+    MetricCard: import("react").FC<import("../pisellMetricCard").PisellMetricCardProps>;
+    StatisticList: (props: import("../pisellStatisticList").PisellStatisticListProps) => JSX.Element;
+    MetricItem: (props: import("../cardMetricItem").PisellStatisticProps) => JSX.Element;
+};
+export default PisellMetrics;
+export type { PisellMetricCardProps } from '../pisellMetricCard';
+export type { PisellStatisticProps } from '../cardMetricItem';

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;

package/lib/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/lib/components/PisellProcedure/hooks/useResponsiveClass.d.ts

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

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