@pisell/materials 6.8.15 → 6.8.17

package/lib/components/PisellSteps/hooks/useStepsState.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 管理步骤条状态的 Hook（支持受控和非受控模式）
+ *
+ * @param current - 受控模式下的当前步骤
+ * @param defaultCurrent - 非受控模式下的默认当前步骤
+ * @param onChange - 步骤变更回调函数
+ * @returns [currentStep, setCurrentStep] - 当前步骤和设置步骤的函数
+ */
+export declare function useStepsState(current?: number, defaultCurrent?: number, onChange?: (current: number) => void): [number, (value: number) => void];

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

@@ -0,0 +1,3 @@
+import PisellSteps from './PisellSteps';
+export type { PisellStepsProps, PisellStepItem, StepStatus, StepDirection, StepSize } from './types';
+export default PisellSteps;

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

@@ -0,0 +1,257 @@
+import type { StepsProps, StepProps } from 'antd';
+import type { CSSProperties, ReactNode } from 'react';
+import type { ScrollActionsConfig } from '../PisellScrollView/types';
+/**
+ * 步骤状态类型
+ */
+export declare type StepStatus = 'wait' | 'process' | 'finish' | 'error';
+/**
+ * 步骤条方向
+ */
+export declare type StepDirection = 'horizontal' | 'vertical';
+/**
+ * 步骤条尺寸
+ */
+export declare type StepSize = 'small' | 'default' | 'large';
+/**
+ * 标签放置位置
+ */
+export declare type StepLabelPlacement = 'horizontal' | 'vertical';
+/**
+ * 单个步骤项配置
+ */
+export interface PisellStepItem extends Omit<StepProps, 'status' | 'onClick'> {
+    /**
+     * 步骤标题
+     */
+    title?: ReactNode;
+    /**
+     * 步骤副标题
+     */
+    subTitle?: ReactNode;
+    /**
+     * 步骤描述
+     */
+    description?: ReactNode;
+    /**
+     * 步骤状态
+     * @default 'wait'
+     */
+    status?: StepStatus;
+    /**
+     * 步骤图标
+     */
+    icon?: ReactNode;
+    /**
+     * 是否禁用点击
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * 是否隐藏该步骤（用于动态步骤）
+     * @default false
+     */
+    hidden?: boolean;
+    /**
+     * 步骤点击回调
+     */
+    onClick?: () => void;
+    /**
+     * 自定义类名
+     */
+    className?: string;
+    /**
+     * 自定义样式
+     */
+    style?: CSSProperties;
+    /**
+     * 额外的数据（可用于业务扩展）
+     */
+    extra?: Record<string, any>;
+}
+/**
+ * PisellSteps 组件 Props
+ */
+export interface PisellStepsProps extends Omit<StepsProps, 'items' | 'onChange' | 'current' | 'status' | 'size' | 'direction'> {
+    /**
+     * 步骤条类型（直接使用 antd 的 type）
+     * @description 'default' - 默认样式，'navigation' - 导航样式
+     * @description dot 模式通过 progressDot 属性来控制，不需要单独的 type
+     * @default 'default'
+     */
+    type?: StepsProps['type'];
+    /**
+     * 当前步骤（受控模式）
+     */
+    current?: number;
+    /**
+     * 默认当前步骤（非受控模式）
+     * @default 0
+     */
+    defaultCurrent?: number;
+    /**
+     * 步骤条方向
+     * @default 'horizontal'
+     */
+    direction?: StepDirection;
+    /**
+     * 步骤条尺寸
+     * @default 'default'
+     */
+    size?: StepSize;
+    /**
+     * 当前步骤的状态
+     * @default 'process'
+     */
+    status?: StepStatus;
+    /**
+     * 起始步骤索引
+     * @default 0
+     */
+    initial?: number;
+    /**
+     * 步骤数据配置
+     */
+    items?: PisellStepItem[];
+    /**
+     * 标签文本位置（标识区和文本区的布局方式）
+     * @description 'horizontal' - 文本在图标右侧（水平布局），'vertical' - 文本在图标下方（垂直布局）
+     * @description 仅在 direction='horizontal' 时生效
+     * @default 'horizontal'
+     */
+    labelPlacement?: StepLabelPlacement;
+    /**
+     * 是否开启响应式
+     * @default true
+     */
+    responsive?: boolean;
+    /**
+     * 步骤变更回调
+     */
+    onChange?: (current: number) => void;
+    /**
+     * 自定义类名
+     */
+    className?: string;
+    /**
+     * 自定义样式
+     */
+    style?: CSSProperties;
+    /**
+     * 点状步骤条是否显示点（也可以传入自定义渲染函数）
+     * @default false
+     */
+    progressDot?: boolean | ((dot: ReactNode, info: {
+        index: number;
+        status: StepStatus;
+        title?: ReactNode;
+        description?: ReactNode;
+    }) => ReactNode);
+    /**
+     * 是否允许点击步骤切换
+     * @default false
+     */
+    clickable?: boolean;
+    /**
+     * 是否允许点击已完成的步骤
+     * @default true
+     */
+    allowClickFinished?: boolean;
+    /**
+     * 是否开启栅格布局
+     * @default false
+     */
+    gridLayout?: boolean;
+    /**
+     * 栅格列数（仅在 gridLayout=true 时有效）
+     */
+    gridColumns?: number;
+    /**
+     * 标识区和文本区的间距（单位：px）
+     * @description 控制图标和文本之间的间距
+     */
+    itemGap?: number;
+    /**
+     * 是否开启锚链接
+     * @default false
+     */
+    enableAnchor?: boolean;
+    /**
+     * 锚链接容器选择器（仅在 enableAnchor=true 时有效）
+     */
+    anchorContainer?: string | HTMLElement;
+    /**
+     * 移动端显示模式
+     * - 'full': 显示完整步骤条（默认）
+     * - 'current': 只显示当前步骤信息
+     * - 'auto': 自动根据屏幕宽度切换（<744px 时显示当前步骤）
+     * @default 'full'
+     */
+    mobileMode?: 'full' | 'current' | 'auto';
+    /**
+     * 移动端断点宽度（单位：px）
+     * @default 744
+     */
+    mobileBreakpoint?: number;
+    /**
+     * 是否启用横向滚动模式
+     * @description 当步骤条宽度不足时，启用横向滚动并显示左右箭头按钮
+     * @default false
+     */
+    enableScrollMode?: boolean;
+    /**
+     * 滚动箭头配置
+     * @description 配置滚动箭头的显示类型和滚动距离
+     */
+    scrollActionsConfig?: ScrollActionsConfig;
+    /**
+     * 设计模式标识（低代码引擎使用）
+     */
+    __designMode?: 'design' | 'preview';
+    /**
+     * 组件唯一标识（低代码引擎使用）
+     */
+    __id?: string;
+    /**
+     * 其他扩展配置
+     */
+    other?: Record<string, any>;
+}
+/**
+ * 步骤点击事件参数
+ */
+export interface StepClickInfo {
+    /**
+     * 步骤索引
+     */
+    index: number;
+    /**
+     * 步骤配置
+     */
+    item: PisellStepItem;
+    /**
+     * 步骤状态
+     */
+    status: StepStatus;
+    /**
+     * 是否可点击
+     */
+    clickable: boolean;
+}
+/**
+ * 步骤变更事件参数
+ */
+export interface StepChangeInfo {
+    /**
+     * 当前步骤索引
+     */
+    current: number;
+    /**
+     * 上一个步骤索引
+     */
+    previous: number;
+    /**
+     * 步骤变更方向
+     */
+    direction: 'forward' | 'backward';
+}

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

@@ -0,0 +1,54 @@
+import type { StepStatus } from '../types';
+/**
+ * 计算当前步骤的进度百分比
+ *
+ * @param current - 当前步骤索引
+ * @param total - 总步骤数
+ * @returns 进度百分比（0-100）
+ */
+export declare function calculateProgress(current: number, total: number): number;
+/**
+ * 判断步骤是否可点击
+ *
+ * @param index - 步骤索引
+ * @param current - 当前步骤索引
+ * @param status - 步骤状态
+ * @param clickable - 全局是否可点击
+ * @param allowClickFinished - 是否允许点击已完成步骤
+ * @returns 是否可点击
+ */
+export declare function isStepClickable(index: number, current: number, status: StepStatus, clickable: boolean, allowClickFinished: boolean): boolean;
+/**
+ * 获取步骤状态
+ *
+ * @param index - 步骤索引
+ * @param current - 当前步骤索引
+ * @param customStatus - 自定义状态（优先级最高）
+ * @returns 步骤状态
+ */
+export declare function getStepStatus(index: number, current: number, customStatus?: StepStatus): StepStatus;
+/**
+ * 合并步骤类名
+ *
+ * @param baseClass - 基础类名
+ * @param status - 步骤状态
+ * @param customClass - 自定义类名
+ * @returns 合并后的类名
+ */
+export declare function mergeStepClassName(baseClass: string, status: StepStatus, customClass?: string): string;
+/**
+ * 判断步骤变更方向
+ *
+ * @param from - 原步骤索引
+ * @param to - 目标步骤索引
+ * @returns 变更方向
+ */
+export declare function getChangeDirection(from: number, to: number): 'forward' | 'backward';
+/**
+ * 验证步骤索引是否有效
+ *
+ * @param index - 步骤索引
+ * @param total - 总步骤数
+ * @returns 是否有效
+ */
+export declare function isValidStepIndex(index: number, total: number): boolean;

package/lib/components/PisellSuperTabs/PisellSuperTabs.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { PisellSuperTabsProps } from './types';
+import './PisellSuperTabs.less';
+interface PisellSuperTabsRef {
+    scrollItemByRowKey: (key: string) => void;
+}
+declare const _default: React.ForwardRefExoticComponent<PisellSuperTabsProps<unknown> & React.RefAttributes<PisellSuperTabsRef>>;
+export default _default;

package/lib/components/PisellSuperTabs/hooks/index.d.ts

@@ -0,0 +1 @@
+export { useTabsState } from './useTabsState';

package/lib/components/PisellSuperTabs/hooks/useTabsState.d.ts

@@ -0,0 +1,7 @@
+import { UseTabsStateParams, UseTabsStateReturn } from '../types';
+/**
+ * Tabs 状态管理 Hook
+ * @description 处理受控/非受控模式的状态管理
+ * @template T - 数据项类型
+ */
+export declare const useTabsState: <T = any>(params: UseTabsStateParams<T>) => UseTabsStateReturn<T>;

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

@@ -0,0 +1,3 @@
+import PisellSuperTabs from './PisellSuperTabs';
+export default PisellSuperTabs;
+export type { PisellSuperTabsProps, TabDataItem } from './types';

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

@@ -0,0 +1,210 @@
+import { CSSProperties, ReactNode } from 'react';
+import type { PisellBasicGridProps } from '../PisellBasicGrid/types';
+import type { PisellScrollViewProps } from '../PisellScrollView/types';
+import type { PisellBasicCardProps } from '../PisellCards/types';
+/**
+ * useTabsState Hook 参数
+ */
+export interface UseTabsStateParams<T = any> {
+    /**
+     * 当前激活的 Tab key（受控）
+     */
+    value?: string;
+    /**
+     * 默认激活的 Tab key（非受控）
+     */
+    defaultValue?: string;
+    /**
+     * Tab 切换时的回调
+     */
+    onChange?: (key: string, item: T) => void;
+}
+/**
+ * useTabsState Hook 返回值
+ */
+export interface UseTabsStateReturn<T = any> {
+    /**
+     * 当前激活的 Tab key
+     */
+    activeKey: string | undefined;
+    /**
+     * 切换 Tab 的方法
+     */
+    handleTabChange: (key: string, item: T) => void;
+}
+export interface RenderItemProps<T = any> extends PisellBasicCardProps {
+    index: number;
+    tabsState: UseTabsStateReturn<T>;
+    tabsProps: PisellSuperTabsProps<T>;
+}
+/**
+ * PisellSuperTabs 组件 Props
+ * @template T - 数据源项的类型
+ * @description 通用导航框架封装的全能型 Tab 组件
+ */
+export interface PisellSuperTabsProps<T = any> {
+    /**
+     * 自定义类名
+     * @description 添加到最外层容器的类名
+     */
+    className?: string;
+    tabItemClassName?: string;
+    tabItemStyle?: CSSProperties;
+    /**
+     * 自定义样式
+     * @description 添加到最外层容器的样式
+     */
+    style?: CSSProperties;
+    /**
+     * 唯一标识
+     * @description 必填，用于区分不同的 TabItem
+     */
+    id?: string;
+    /**
+     * 数据源
+     * @description 支持多级嵌套，递归字段为 children
+     * @example
+     * [
+     *   { key: 'home', label: '首页' },
+     *   { key: 'products', label: '产品', children: [...] }
+     * ]
+     */
+    dataSource?: T[];
+    /**
+     * 数据项的唯一标识字段
+     * @default 'key'
+     * @description 可以是字符串（字段名）或函数（自定义获取逻辑）
+     * @example
+     * // 字符串形式
+     * rowKey="id"
+     *
+     * // 函数形式
+     * rowKey={(record, index) => `${record.type}-${index}`}
+     */
+    rowKey?: string | ((record: T, index: number) => string);
+    /**
+     * 当前激活的 Tab key
+     * @description 受控模式，需配合 onChange 使用
+     */
+    value?: string;
+    /**
+     * 默认激活的 Tab key
+     * @description 非受控模式，仅初始化时生效
+     */
+    defaultValue?: string;
+    /**
+     * Tab 切换时的回调
+     * @param key - 切换到的 Tab key
+     * @param item - 切换到的数据项
+     */
+    onChange?: (key: string, item: T) => void;
+    /**
+     * 自定义 TabItem 渲染
+     * @description 支持两种模式：
+     * 1. 函数模式：(item, index, active) => ReactNode
+     * 2. 插槽模式：直接传入 ReactNode
+     * @example
+     * // 函数模式
+     * renderItem={(item, index, active) => (
+     *   <PisellCards.TabCard
+     *     {...item}
+     *     active={{ value: active }}
+     *   />
+     * )}
+     *
+     * // 插槽模式
+     * renderItem={<PisellCards.TabCard />}
+     */
+    renderItem?: ((props: RenderItemProps<T>) => ReactNode) | ReactNode;
+    /**
+     * PisellBasicGrid 组件的配置
+     * @description 透传给 PisellBasicGrid 组件的所有 Props
+     * @see PisellBasicGridProps
+     * @example
+     * gridProps={{
+     *   direction: 'horizontal',
+     *   gap: 16,
+     *   wrap: 'wrap',
+     *   columns: 4,
+     * }}
+     */
+    gridProps?: Omit<PisellBasicGridProps<T>, 'dataSource' | 'renderItem' | 'rowKey' | 'children'>;
+    /**
+     * PisellScrollView 组件的配置
+     * @description 透传给 PisellScrollView 组件的所有 Props
+     * @see PisellScrollViewProps
+     * @example
+     * scrollViewProps={{
+     *   overflow: 'x',
+     *   scrollbarStyle: 'thin',
+     *   scrollActionsConfig: { show: true, type: 'lrArrows' },
+     * }}
+     */
+    scrollViewProps?: Omit<PisellScrollViewProps, 'children'>;
+    children?: ReactNode;
+    /**
+     * 左侧插槽
+     */
+    slotLeft?: ReactNode;
+    slotLeftClassName?: string;
+    slotLeftStyle?: CSSProperties;
+    /**
+     * 右侧插槽
+     */
+    slotRight?: ReactNode;
+    slotRightClassName?: string;
+    slotRightStyle?: CSSProperties;
+    /**
+     * 顶部插槽
+     */
+    slotTop?: ReactNode;
+    slotTopClassName?: string;
+    slotTopStyle?: CSSProperties;
+    /**
+     * 底部插槽
+     */
+    slotBottom?: ReactNode;
+    slotBottomClassName?: string;
+    slotBottomStyle?: CSSProperties;
+    __designMode?: boolean;
+}
+/**
+ * 数据项基础类型
+ * @description 建议数据源中的每一项都包含这些字段
+ */
+export interface TabDataItem {
+    /**
+     * 唯一标识
+     * @description 必填，用于区分不同的 TabItem
+     */
+    key: string;
+    /**
+     * 标签文本
+     */
+    label?: string;
+    /**
+     * 图标
+     */
+    icon?: ReactNode;
+    /**
+     * 徽章配置
+     */
+    badge?: {
+        count?: number;
+        dot?: boolean;
+        text?: string;
+    };
+    /**
+     * 子级数据（多级嵌套）
+     * @description 用于多级导航场景，具体渲染逻辑由 Card 组件实现
+     */
+    children?: TabDataItem[];
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 其他自定义字段
+     */
+    [key: string]: any;
+}

package/lib/components/PisellSuperTabs/utils/getRowKey.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 获取数据项的唯一标识
+ * @param record - 数据项
+ * @param index - 索引
+ * @param rowKey - key 字段配置
+ * @returns 唯一标识字符串
+ */
+export declare const getRowKey: <T = any>(record: T, index: number, rowKey?: string | ((record: T, index: number) => string) | undefined) => string;

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

@@ -0,0 +1 @@
+export { getRowKey } from './getRowKey';

package/lib/components/PisellTabbar/constants.d.ts

@@ -0,0 +1,46 @@
+import { TabbarLevelConfig, ExpandConfig, LevelType } from './types';
+/**
+ * 默认层级配置
+ */
+export declare const DEFAULT_LEVEL_CONFIG: Record<LevelType, TabbarLevelConfig>;
+/**
+ * 获取展开配置
+ */
+export declare const getExpandConfig: () => ExpandConfig;
+/**
+ * 默认数据项配置
+ */
+export declare const DEFAULT_ITEMS: {
+    all: {
+        id: string;
+        shop_id: number;
+        parent_id: number;
+        name: any;
+        slug: string;
+        icon: string;
+    };
+    search: {
+        id: string;
+        shop_id: number;
+        parent_id: number;
+        name: string;
+        slug: string;
+        key: string;
+        icon: string;
+        customClick: boolean;
+    };
+    expand: {
+        id: string;
+        shop_id: number;
+        parent_id: number;
+        key: string;
+        icon: string;
+        name: string;
+        slug: string;
+        customClick: boolean;
+    };
+};
+/**
+ * 获取层级对应的添加项配置
+ */
+export declare const LEVEL_ADD_ITEMS: Record<LevelType, ('all' | 'search' | 'expand')[]>;

package/lib/components/PisellTabbar/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export { default as useActiveKey } from './useActiveKey';
+export { default as useExpand } from './useExpand';

package/lib/components/PisellTabbar/hooks/useActiveKey.d.ts

@@ -0,0 +1,49 @@
+/**
+ * useActiveKey Hook 参数
+ */
+interface UseActiveKeyProps {
+    /** 初始激活的 key 数组（对应多层级） */
+    initialActiveKey?: (string | number)[];
+    /** key 变化回调 */
+    onChange?: (value: (string | number)[]) => void;
+}
+/**
+ * useActiveKey Hook 返回值
+ */
+interface UseActiveKeyReturn {
+    /** 当前激活的 key 数组 */
+    activeKey: (string | number)[];
+    /** 设置指定层级的激活 key */
+    setActiveKey: (level: number, key: string | number, cKey?: string | number) => void;
+    /** 获取指定层级的激活 key */
+    getActiveKey: (level: number) => string | number;
+    /** 内部设置方法（用于同步外部值） */
+    _setActiveKey: (value: (string | number)[]) => void;
+}
+/**
+ * Tabbar 激活状态管理 Hook
+ *
+ * 用于管理多层级 Tabbar 的激活状态，支持级联选择
+ *
+ * @param props - Hook 配置参数
+ * @returns 激活状态和操作方法
+ *
+ * @example
+ * ```tsx
+ * const { activeKey, setActiveKey, getActiveKey } = useActiveKey({
+ *   initialActiveKey: [1, 10],
+ *   onChange: (value) => console.log('当前选中:', value)
+ * });
+ *
+ * // 设置第 0 层级的 key，并清除后续层级
+ * setActiveKey(0, '2');
+ *
+ * // 设置第 0 层级的 key，并同时设置第 1 层级
+ * setActiveKey(0, '2', '20');
+ *
+ * // 获取第 0 层级的 key
+ * const level0Key = getActiveKey(0);
+ * ```
+ */
+declare const useActiveKey: (props: UseActiveKeyProps) => UseActiveKeyReturn;
+export default useActiveKey;