@pisell/materials 6.11.20 → 6.11.21

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

@@ -1,221 +0,0 @@
-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

@@ -1,63 +0,0 @@
-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

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

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

@@ -1,5 +0,0 @@
-/**
- * BadgeWrapper 角标包装组件
- * 复用 TextCard 的 BadgeWrapper 实现
- */
-export { default } from '../../TextCard/components/BadgeWrapper';

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

@@ -1,24 +0,0 @@
-import React from 'react';
-import { GraphicAreaProps } from '../types';
-/**
- * GraphicArea 图形区域组件
- * 负责渲染图片或图标
- *
- * @component
- * @example
- * ```tsx
- * // 渲染图片
- * <GraphicArea
- *   image="https://example.com/image.png"
- *   config={{ width: 60, height: 60, borderRadius: 8 }}
- * />
- *
- * // 渲染图标
- * <GraphicArea
- *   icon={<SmileIcon />}
- *   config={{ width: 36, height: 36, iconSize: 24, iconColor: '#7F56D9' }}
- * />
- * ```
- */
-declare const GraphicArea: React.FC<GraphicAreaProps>;
-export default GraphicArea;

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

@@ -1,27 +0,0 @@
-import React from 'react';
-import { TextContentProps } from '../types';
-/**
- * TextContent 文本内容组件
- * 负责渲染主文本内容，支持省略和多行显示
- *
- * @component
- * @example
- * ```tsx
- * // 单行文本
- * <TextContent text="Tab title" />
- *
- * // 自定义样式
- * <TextContent
- *   text="Tab title"
- *   textConfig={{
- *     fontSize: 16,
- *     fontWeight: 600,
- *     color: '#101828',
- *     maxLines: 2,
- *     textAlign: 'center'
- *   }}
- * />
- * ```
- */
-declare const TextContent: React.FC<TextContentProps>;
-export default TextContent;

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

@@ -1,6 +0,0 @@
-/**
- * 子组件统一导出
- */
-export { default as GraphicArea } from './GraphicArea';
-export { default as TextContent } from './TextContent';
-export { default as BadgeWrapper } from './BadgeWrapper';

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

@@ -1,5 +0,0 @@
-/**
- * Hooks 统一导出
- */
-export { useGraphicTextCardStyle } from './useGraphicTextCardStyle';
-export { useGraphicTextCardClick } from './useGraphicTextCardClick';

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

@@ -1,15 +0,0 @@
-import { GraphicTextCardProps } from '../types';
-/**
- * useGraphicTextCardClick Hook
- * 处理组件点击事件的逻辑
- *
- * @param props - GraphicTextCard 组件的 Props
- * @returns 点击事件处理函数
- *
- * @example
- * ```tsx
- * const handleClick = useGraphicTextCardClick(props);
- * <div onClick={handleClick}>...</div>
- * ```
- */
-export declare const useGraphicTextCardClick: (props: GraphicTextCardProps) => (event: React.MouseEvent<HTMLDivElement>) => void;

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

@@ -1,18 +0,0 @@
-import { CSSProperties } from 'react';
-import { GraphicTextCardProps } from '../types';
-/**
- * useGraphicTextCardStyle Hook
- * 处理组件样式和类名的合并逻辑
- *
- * @param props - GraphicTextCard 组件的 Props
- * @returns 合并后的样式和类名
- *
- * @example
- * ```tsx
- * const { mergedStyle, mergedClassName } = useGraphicTextCardStyle(props);
- * ```
- */
-export declare const useGraphicTextCardStyle: (props: GraphicTextCardProps) => {
-    mergedStyle: CSSProperties;
-    mergedClassName: string;
-};

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

@@ -1,5 +0,0 @@
-/**
- * GraphicTextCard 组件入口文件
- */
-export { default } from './GraphicTextCard';
-export type { GraphicTextCardProps, GraphicTextCardVariant, GraphicTextCardSize, GraphicTextCardWidthMode, GraphicConfig, BadgeConfig, TextConfig, } from './types';