@pisell/materials 3.3.90 → 3.3.92

package/lib/components/PisellBasicGrid/types.d.ts

@@ -0,0 +1,221 @@
+import type { CSSProperties, ReactNode } from 'react';
+/**
+ * 排列方向类型
+ * @description 控制子元素的排列方向
+ */
+export declare type DirectionType = 'horizontal' | 'horizontal-reverse' | 'vertical' | 'vertical-reverse';
+/**
+ * 换行类型
+ * @description 控制子元素是否换行
+ */
+export declare type WrapType = 'nowrap' | 'wrap' | 'wrap-reverse';
+/**
+ * 主轴对齐类型
+ * @description 控制子元素在主轴上的对齐方式
+ */
+export declare type JustifyType = 'start' | 'end' | 'center' | 'between' | 'around' | 'evenly';
+/**
+ * 交叉轴对齐类型
+ * @description 控制子元素在交叉轴上的对齐方式
+ */
+export declare type AlignType = 'start' | 'end' | 'center' | 'stretch' | 'baseline';
+/**
+ * 多行对齐类型
+ * @description 控制多行时行与行之间的对齐方式
+ */
+export declare type AlignContentType = 'start' | 'end' | 'center' | 'between' | 'around' | 'stretch';
+/**
+ * 响应式断点类型
+ * @description 响应式配置的断点名称
+ */
+export declare type BreakpointType = 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
+/**
+ * 响应式配置类型（预留）
+ * @description 用于配置不同断点下的布局属性
+ */
+export interface ResponsiveConfig {
+    /** 一行显示的元素个数 */
+    columns?: number;
+    /** 间距 */
+    gap?: number | string;
+    /** 排列方向 */
+    direction?: DirectionType;
+}
+/**
+ * PisellBasicGrid 组件 Props
+ * @template T - 数据源项的类型
+ * @description 基于 Flexbox 的基础布局组件属性定义
+ */
+export interface PisellBasicGridProps<T = any> {
+    /**
+     * 子元素
+     * @description 当未传入 dataSource 时使用
+     */
+    children?: ReactNode;
+    /**
+     * 自定义类名
+     * @description 添加到容器元素的额外类名
+     */
+    className?: string;
+    /**
+     * 自定义样式
+     * @description 支持所有 CSS 属性，会与组件计算的样式合并
+     */
+    style?: CSSProperties;
+    /**
+     * 排列方向
+     * @default 'horizontal'
+     * @description
+     * - horizontal: 横向排列
+     * - horizontal-reverse: 横向反向排列
+     * - vertical: 竖向排列
+     * - vertical-reverse: 竖向反向排列
+     */
+    direction?: DirectionType;
+    /**
+     * 换行控制
+     * @default 'nowrap'
+     * @description
+     * - nowrap: 不换行
+     * - wrap: 换行
+     * - wrap-reverse: 反向换行
+     */
+    wrap?: WrapType;
+    /**
+     * 一行显示的元素个数
+     * @description 设置后子元素宽度为 calc((100% - gap * (N-1)) / N)
+     * @note 优先级高于 equalWidth
+     */
+    columns?: number;
+    /**
+     * 是否等分容器宽度
+     * @default false
+     * @description 设置为 true 时，子元素会平均分配容器宽度 (flex: 1)
+     * @note 当设置了 columns 时，此属性无效
+     */
+    equalWidth?: boolean;
+    /**
+     * 间距（统一设置行列间距）
+     * @description 数字类型默认单位为 px，也可传入带单位的字符串
+     * @example gap={16} 或 gap="1rem"
+     */
+    gap?: number | string;
+    /**
+     * 行间距
+     * @description 优先级高于 gap
+     */
+    rowGap?: number | string;
+    /**
+     * 列间距
+     * @description 优先级高于 gap
+     */
+    columnGap?: number | string;
+    /**
+     * 主轴对齐方式
+     * @default 'start'
+     * @description
+     * - start: 起始对齐
+     * - end: 末尾对齐
+     * - center: 居中对齐
+     * - between: 两端对齐
+     * - around: 等间距对齐
+     * - evenly: 均匀分布
+     */
+    justify?: JustifyType;
+    /**
+     * 交叉轴对齐方式
+     * @default 'stretch'
+     * @description
+     * - start: 顶部对齐
+     * - end: 底部对齐
+     * - center: 居中对齐
+     * - stretch: 拉伸填充
+     * - baseline: 基线对齐
+     */
+    align?: AlignType;
+    /**
+     * 多行对齐方式
+     * @default 'stretch'
+     * @description 当存在多行时，控制行与行之间的对齐方式
+     * - start: 顶部对齐
+     * - end: 底部对齐
+     * - center: 居中对齐
+     * - between: 两端对齐
+     * - around: 等间距对齐
+     * - stretch: 拉伸填充
+     */
+    alignContent?: AlignContentType;
+    /**
+     * 响应式配置（预留）
+     * @description 当前版本暂不实现，后续版本迭代
+     */
+    responsive?: Partial<Record<BreakpointType, ResponsiveConfig>>;
+    /**
+     * 数据源数组
+     * @description
+     * - 当传入 dataSource 时，组件内部会自动循环渲染
+     * - dataSource 为 undefined 时，渲染 children
+     * - dataSource 为空数组时，不渲染任何内容
+     */
+    dataSource?: T[];
+    /**
+     * 渲染函数
+     * @param item - 当前数据项
+     * @param index - 当前索引
+     * @returns ReactNode
+     * @description 用于自定义每个数据项的渲染内容
+     */
+    renderItem?: (item: T, index: number) => ReactNode;
+    /**
+     * 指定每项的唯一 key
+     * @description
+     * - 传入 string 时，作为数据项的属性名获取 key
+     * - 传入函数时，通过函数返回 key
+     * - 不传时，默认使用 index 作为 key
+     * @example rowKey="id" 或 rowKey={(item, index) => `item-${item.id}`}
+     */
+    rowKey?: string | ((item: T, index: number) => string);
+    /**
+     * 前置插槽
+     * @description 在数据源渲染之前渲染
+     */
+    startSlot?: ReactNode;
+    /**
+     * 后置插槽
+     * @description 在数据源渲染之后渲染
+     */
+    endSlot?: ReactNode;
+}
+/**
+ * 容器样式配置
+ * @description useGridStyle Hook 返回的容器样式类型
+ */
+export interface ContainerStyle extends CSSProperties {
+    display: 'flex';
+    flexDirection: CSSProperties['flexDirection'];
+    flexWrap: CSSProperties['flexWrap'];
+    justifyContent: CSSProperties['justifyContent'];
+    alignItems: CSSProperties['alignItems'];
+    alignContent?: CSSProperties['alignContent'];
+    gap?: CSSProperties['gap'];
+    rowGap?: CSSProperties['rowGap'];
+    columnGap?: CSSProperties['columnGap'];
+}
+/**
+ * 子元素样式配置
+ * @description useGridStyle Hook 返回的子元素样式类型
+ */
+export interface ItemStyle extends CSSProperties {
+    flexBasis?: CSSProperties['flexBasis'];
+    flexGrow?: CSSProperties['flexGrow'];
+    flexShrink?: CSSProperties['flexShrink'];
+}
+/**
+ * useGridStyle Hook 返回值类型
+ */
+export interface UseGridStyleReturn {
+    /** 容器样式 */
+    containerStyle: ContainerStyle;
+    /** 子元素样式 */
+    itemStyle: ItemStyle;
+}

package/lib/components/PisellBasicGrid/utils/index.d.ts

@@ -0,0 +1,63 @@
+import type { DirectionType, WrapType, JustifyType, AlignType, AlignContentType } from '../types';
+/**
+ * 将间距值转换为 CSS 值
+ * @param value - 间距值，可以是数字或字符串
+ * @returns CSS 间距值字符串
+ * @example
+ * normalizeGap(16) // '16px'
+ * normalizeGap('1rem') // '1rem'
+ * normalizeGap(undefined) // undefined
+ */
+export declare const normalizeGap: (value: number | string | undefined) => string | undefined;
+/**
+ * 计算 flex-basis 值，考虑 gap 影响
+ * @param columns - 一行显示的元素个数
+ * @param gap - 间距值
+ * @returns flex-basis CSS 值
+ * @description 公式：calc((100% - gap * (N-1)) / N)
+ * @example
+ * calculateFlexBasis(4, 16) // 'calc((100% - 16px * 3) / 4)'
+ * calculateFlexBasis(3, '1rem') // 'calc((100% - 1rem * 2) / 3)'
+ */
+export declare const calculateFlexBasis: (columns: number, gap?: number | string) => string;
+/**
+ * 获取数据项的唯一 key
+ * @param item - 数据项
+ * @param index - 索引
+ * @param rowKey - rowKey 配置
+ * @returns 唯一 key 字符串
+ * @example
+ * getRowKey({ id: 1 }, 0, 'id') // '1'
+ * getRowKey({ id: 1 }, 0, (item, index) => `item-${item.id}`) // 'item-1'
+ * getRowKey({ id: 1 }, 0) // '0'
+ */
+export declare const getRowKey: <T>(item: T, index: number, rowKey?: string | ((item: T, index: number) => string) | undefined) => string;
+/**
+ * flex-direction 映射表
+ * @description 将 direction 属性值映射为 CSS flex-direction 值
+ */
+export declare const DIRECTION_MAP: Record<DirectionType, 'row' | 'row-reverse' | 'column' | 'column-reverse'>;
+/**
+ * flex-wrap 映射表
+ * @description 将 wrap 属性值映射为 CSS flex-wrap 值
+ */
+export declare const WRAP_MAP: Record<WrapType, 'nowrap' | 'wrap' | 'wrap-reverse'>;
+/**
+ * justify-content 映射表
+ * @description 将 justify 属性值映射为 CSS justify-content 值
+ */
+export declare const JUSTIFY_MAP: Record<JustifyType, 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'space-evenly'>;
+/**
+ * align-items 映射表
+ * @description 将 align 属性值映射为 CSS align-items 值
+ */
+export declare const ALIGN_MAP: Record<AlignType, 'flex-start' | 'flex-end' | 'center' | 'stretch' | 'baseline'>;
+/**
+ * align-content 映射表
+ * @description 将 alignContent 属性值映射为 CSS align-content 值
+ */
+export declare const ALIGN_CONTENT_MAP: Record<AlignContentType, 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'stretch'>;
+/**
+ * 组件样式前缀
+ */
+export declare const COMPONENT_PREFIX = "pisell-basic-grid";

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

@@ -0,0 +1,8 @@
+/**
+ * PisellCards 命名空间容器
+ * 用于收纳所有卡片组件
+ * 注意：PisellCards 自身不作为组件直接使用
+ */
+import React from 'react';
+declare const PisellCards: React.FC;
+export default PisellCards;

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

@@ -1,9 +1,9 @@
-import React from 'react';
+/// <reference types="react" />
 import { GraphicTextCardProps } from './types';
 import './GraphicTextCard.less';
 /**
  * Provider 包装器
  * 兼容 PisellCards 系统的 props 传递方式
  */
-declare const Provider: (props: GraphicTextCardProps) => React.JSX.Element;
+declare const Provider: (props: GraphicTextCardProps) => JSX.Element;
 export default Provider;

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

@@ -0,0 +1,19 @@
+import React from 'react';
+import { MultilevelCardProps } from './types';
+import './MultilevelCard.less';
+/**
+ * MultilevelCard 组件
+ * 多层级卡片组件，支持点击或 hover 展开次级面板
+ *
+ * @example
+ * ```tsx
+ * <MultilevelCard
+ *   card={<TextCard text="分类1" />}
+ *   panel={<div>次级内容</div>}
+ *   trigger="click"
+ * />
+ * ```
+ */
+export declare const MultilevelCard: React.FC<MultilevelCardProps<any>>;
+declare const Provider: (props: any) => JSX.Element;
+export default Provider;

package/lib/components/PisellCards/components/MultilevelCard/components/CardWrapper.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { CardWrapperProps } from '../types';
+/**
+ * CardWrapper 组件
+ * 主卡片包装器，负责注入事件监听
+ */
+export declare const CardWrapper: React.FC<CardWrapperProps>;

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

@@ -0,0 +1,2 @@
+export { CardWrapper } from './CardWrapper';
+export { PanelWrapper } from './PanelWrapper';

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

@@ -0,0 +1,2 @@
+export { useMultilevelCardExpand } from './useMultilevelCardExpand';
+export { useMultilevelCardHover } from './useMultilevelCardHover';

package/lib/components/PisellCards/components/MultilevelCard/hooks/useMultilevelCardExpand.d.ts

@@ -0,0 +1,32 @@
+/// <reference types="react" />
+import { MultilevelCardTrigger } from '../types';
+/**
+ * 管理 MultilevelCard 的展开/收起状态
+ */
+export interface UseMultilevelCardExpandOptions {
+    /**
+     * 主卡片组件
+     */
+    active: any;
+    /**
+     * 触发方式
+     */
+    trigger: MultilevelCardTrigger;
+    /**
+     * 展开状态变化回调
+     */
+    onExpandChange?: (expanded: boolean) => void;
+    /**
+     * 设计模式
+     */
+    __designMode?: boolean;
+}
+/**
+ * 展开/收起状态管理 Hook
+ * @param options - 配置选项
+ * @returns 展开状态和设置函数
+ */
+export declare const useMultilevelCardExpand: (options: UseMultilevelCardExpandOptions) => {
+    expanded: boolean;
+    setExpanded: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+};

package/lib/components/PisellCards/components/MultilevelCard/hooks/useMultilevelCardHover.d.ts

@@ -0,0 +1,28 @@
+import { MultilevelCardHoverDelay } from '../types';
+/**
+ * Hover 交互 Hook 的配置选项
+ */
+export interface UseMultilevelCardHoverOptions {
+    /**
+     * 是否启用 hover
+     */
+    enabled: boolean;
+    /**
+     * 延迟配置
+     */
+    delay?: MultilevelCardHoverDelay;
+    /**
+     * 展开状态变化回调
+     */
+    onExpandChange: (expanded: boolean) => void;
+}
+/**
+ * Hover 交互处理 Hook
+ * @param options - 配置选项
+ * @returns 鼠标事件处理函数
+ */
+export declare const useMultilevelCardHover: (options: UseMultilevelCardHoverOptions) => {
+    onMouseEnter: () => void;
+    onMouseLeave: () => void;
+    clearTimers: () => void;
+};

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

@@ -0,0 +1,2 @@
+export { default } from './MultilevelCard';
+export type { MultilevelCardProps } from './types';

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

@@ -0,0 +1,202 @@
+import { CSSProperties, ReactNode } from 'react';
+import { PisellBasicCardProps } from '../../types';
+/**
+ * 触发方式类型
+ */
+export declare type MultilevelCardTrigger = 'click' | 'hover';
+/**
+ * 次级面板宽度模式
+ */
+export declare type MultilevelCardPanelWidthMode = 'auto' | 'fixed' | 'full';
+/**
+ * Hover 延迟配置
+ */
+export interface MultilevelCardHoverDelay {
+    /**
+     * 鼠标进入延迟时间（毫秒）
+     * @default 100
+     */
+    enter?: number;
+    /**
+     * 鼠标离开延迟时间（毫秒）
+     * @default 200
+     */
+    leave?: number;
+}
+/**
+ * MultilevelCard 组件 Props
+ */
+export interface MultilevelCardProps<T> extends PisellBasicCardProps {
+    /**
+     * 主卡片插槽
+     * 传入任意 Card 组件（如 TextCard、GraphicTextCard 等）
+     * 主卡片需实现 PisellBasicCardProps 中的 active 属性（click 模式下）
+     */
+    card: (props: T) => ReactNode;
+    /**
+     * 次级面板插槽
+     * 传入自定义内容，当主卡片 active 时展示
+     */
+    panel?: (props: T) => ReactNode;
+    /**
+     * 触发方式
+     * - click: 点击触发，通过主卡片的 active 状态控制展开/收起
+     * - hover: 悬停触发，鼠标进入展开，离开时收起
+     * @default 'click'
+     */
+    trigger?: MultilevelCardTrigger;
+    /**
+     * hover 模式下的延迟时间（毫秒）
+     * 用于防抖处理，避免鼠标快速划过时频繁触发
+     * @default { enter: 100, leave: 200 }
+     */
+    hoverDelay?: MultilevelCardHoverDelay;
+    /**
+     * 次级面板宽度模式
+     * - auto: 内容撑满
+     * - fixed: 固定宽度，需配合 panelWidth 使用
+     * - full: 撑满父容器
+     * @default 'full'
+     */
+    panelWidthMode?: MultilevelCardPanelWidthMode;
+    /**
+     * 固定宽度值（单位：px 或任意 CSS 宽度值）
+     * 当 panelWidthMode='fixed' 时有效
+     * @example 300 | '300px' | '50%'
+     */
+    panelWidth?: number | string;
+    /**
+     * 次级面板样式
+     * 用于自定义次级面板的样式
+     */
+    panelStyle?: CSSProperties;
+    /**
+     * 次级面板类名
+     * 用于自定义次级面板的类名
+     */
+    panelClassName?: string;
+    /**
+     * 次级面板容器
+     * 传入 DOM 节点，次级面板将渲染到该节点中（使用 Portal）
+     * 不传则默认渲染在组件内部（主卡片下方）
+     */
+    panelContainer?: (props: any) => HTMLElement | null;
+    /**
+     * 是否启用动画
+     * 控制次级面板展开/收起时的过渡动画
+     * @default true
+     */
+    animation?: boolean;
+    /**
+     * 动画持续时间（毫秒）
+     * @default 300
+     */
+    animationDuration?: number;
+    /**
+     * 展开状态变化回调
+     * @param expanded - 是否展开
+     */
+    onExpandChange?: (expanded: boolean) => void;
+    /**
+     * 次级面板渲染完成回调
+     * 当次级面板挂载到 DOM 时触发
+     */
+    onPanelMount?: () => void;
+    /**
+     * 次级面板卸载回调
+     * 当次级面板从 DOM 卸载时触发
+     */
+    onPanelUnmount?: () => void;
+    /**
+     * 组件类名
+     */
+    className?: string;
+    /**
+     * 组件样式
+     */
+    style?: CSSProperties;
+}
+/**
+ * CardWrapper 组件 Props
+ * 主卡片包装器子组件
+ */
+export interface CardWrapperProps {
+    /**
+     * 主卡片内容
+     */
+    children: ReactNode;
+    /**
+     * 触发方式
+     */
+    trigger: MultilevelCardTrigger;
+    /**
+     * 点击事件
+     */
+    onClick?: () => void;
+    /**
+     * 鼠标进入事件
+     */
+    onMouseEnter?: () => void;
+    /**
+     * 鼠标离开事件
+     */
+    onMouseLeave?: () => void;
+    /**
+     * 自定义类名
+     */
+    className?: string;
+}
+/**
+ * PanelWrapper 组件 Props
+ * 次级面板包装器子组件
+ */
+export interface PanelWrapperProps {
+    /**
+     * 次级面板内容
+     */
+    children?: ReactNode;
+    /**
+     * 是否可见
+     */
+    visible: boolean;
+    /**
+     * 宽度模式
+     */
+    widthMode?: MultilevelCardPanelWidthMode;
+    /**
+     * 固定宽度值
+     */
+    width?: number | string;
+    /**
+     * 是否启用动画
+     */
+    animation?: boolean;
+    /**
+     * 动画持续时间（毫秒）
+     */
+    animationDuration?: number;
+    /**
+     * 渲染完成回调
+     */
+    onMount?: () => void;
+    /**
+     * 卸载回调
+     */
+    onUnmount?: () => void;
+    /**
+     * 鼠标进入事件（hover 模式下使用）
+     */
+    onMouseEnter?: () => void;
+    /**
+     * 鼠标离开事件（hover 模式下使用）
+     */
+    onMouseLeave?: () => void;
+    /**
+     * 自定义样式
+     */
+    style?: CSSProperties;
+    /**
+     * 自定义类名
+     */
+    className?: string;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * 格式化宽度值
+ * @param width - 宽度值（数字或字符串）
+ * @returns 格式化后的宽度值
+ */
+export declare const formatWidth: (width: number | string | undefined) => string | undefined;

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

@@ -1,9 +1,8 @@
-import React from 'react';
 import { PisellImageCardProps } from './types';
 import './PisellImageCard.less';
 /**
  * Provider 包装器
  * 兼容 PisellCards 系统的 props 传递方式
  */
-declare const Provider: (props: PisellImageCardProps) => React.JSX.Element;
+declare const Provider: (props: PisellImageCardProps) => JSX.Element;
 export default Provider;

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

@@ -0,0 +1,5 @@
+/**
+ * PisellImageCard Hooks 导出
+ */
+export { useImageLoad } from './useImageLoad';
+export { usePisellImageCardStyle } from './usePisellImageCardStyle';

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

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

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;
+};