@pisell/materials 6.8.14 → 6.8.16

package/es/components/PisellProcedure/types.d.ts

@@ -1,363 +0,0 @@
-import type { CSSProperties, ReactNode } from 'react';
-import type { PisellStepsProps } from '../PisellSteps/types';
-/**
- * 步骤项数据
- */
-export interface StepItem {
-    /** 步骤索引 */
-    index?: number;
-    /** 步骤标题 */
-    title?: ReactNode;
-    /** 步骤描述 */
-    description?: ReactNode;
-    /** 其他数据 */
-    [key: string]: any;
-}
-/**
- * 步骤变化结果
- */
-export interface StepChangeResult {
-    /** 是否成功 */
-    success: boolean;
-    /** 当前步骤索引 */
-    currentStep: number;
-    /** 当前步骤数据 */
-    currentItem: StepItem | null;
-}
-/**
- * PisellProcedure Ref 暴露的方法
- * @description 通过 ref 可以调用的组件方法
- */
-export interface PisellProcedureRef {
-    /**
-     * 跳转到上一步
-     * @returns 步骤变化结果，如果无法跳转则返回 null
-     */
-    goPrev: () => StepChangeResult | null;
-    /**
-     * 跳转到下一步
-     * @returns 步骤变化结果，如果无法跳转则返回 null
-     */
-    goNext: () => StepChangeResult | null;
-    /**
-     * 跳转到指定步骤
-     * @param step - 目标步骤索引
-     * @returns 步骤变化结果，如果无法跳转则返回 null
-     */
-    goToStep: (step: number) => StepChangeResult | null;
-    /**
-     * 获取当前步骤索引
-     * @returns 当前步骤索引
-     */
-    getCurrentStep: () => number;
-    /**
-     * 打开移动端总结弹窗
-     */
-    openSummaryModal: () => void;
-    /**
-     * 关闭移动端总结弹窗
-     */
-    closeSummaryModal: () => void;
-}
-/**
- * 返回确认弹窗配置
- */
-export interface BackConfirmModalConfig {
-    /**
-     * 是否启用返回确认弹窗
-     * @default true
-     */
-    enabled?: boolean;
-    /**
-     * 弹窗标题
-     * @description 支持字符串格式
-     */
-    title?: string;
-    /**
-     * 弹窗描述内容
-     * @description 支持字符串格式
-     */
-    describe?: string;
-    /**
-     * 弹窗底部插槽
-     * @description 底部按钮区域，支持放置任意内容
-     */
-    footer?: ReactNode;
-}
-/**
- * 头部插槽顺序
- */
-export declare type HeaderSlotOrder = 'default' | 'reverse';
-/**
- * ProcedureHeader 头部区域配置
- */
-export interface ProcedureHeaderProps {
-    /** 自定义类名 */
-    className?: string;
-    /** 自定义样式 */
-    style?: CSSProperties;
-    /** 左侧插槽（上一步按钮、返回图标等） */
-    left?: ReactNode;
-    /** 右侧插槽（关闭按钮、图标等） */
-    right?: ReactNode;
-    /**
-     * 插槽顺序
-     * @description 'default' - 默认顺序（left 在左，right 在右），'reverse' - 反转顺序（left 在右，right 在左）
-     * @default 'default'
-     */
-    slotOrder?: HeaderSlotOrder;
-    /** 步骤条配置，透传给 PisellSteps 组件 */
-    stepsProps?: PisellStepsProps;
-    /**
-     * 是否显示步骤条
-     * @default true
-     */
-    showSteps?: boolean;
-    /**
-     * 第一步时是否显示返回按钮
-     * @default false
-     */
-    showBackOnFirstStep?: boolean;
-    /**
-     * 返回上一步确认弹窗配置
-     */
-    backConfirmModal?: BackConfirmModalConfig;
-    /**
-     * 关闭确认弹窗配置
-     */
-    closeConfirmModal?: BackConfirmModalConfig;
-}
-/**
- * 主体区域布局模式
- */
-export declare type BodyLayoutMode = 'fixed' | 'ratio';
-/**
- * 内容区与信息区的比例配置
- * @example '7:3' | '6:4'
- */
-export declare type BodyLayoutRatio = `${number}:${number}`;
-/**
- * 主体区域排列方向
- */
-export declare type BodyDirection = 'horizontal' | 'vertical';
-/**
- * 主体区域内容顺序
- */
-export declare type BodyContentOrder = 'content-first' | 'sidebar-first';
-/**
- * ProcedureBody 主体区域配置
- */
-export interface ProcedureBodyProps {
-    /** 自定义类名 */
-    className?: string;
-    /** 自定义样式 */
-    style?: CSSProperties;
-    /**
-     * 排列方向
-     * @description 'horizontal' - 横向排列（左右布局），'vertical' - 纵向排列（上下布局）
-     * @default 'horizontal'
-     */
-    direction?: BodyDirection;
-    /**
-     * 内容顺序
-     * @description 'content-first' - 内容区在前（默认：横向时内容区在左，纵向时内容区在上）
-     * @description 'sidebar-first' - 信息区在前（横向时信息区在左，纵向时信息区在上）
-     * @default 'content-first'
-     */
-    contentOrder?: BodyContentOrder;
-    /**
-     * 布局模式
-     * @description 'fixed' - 固定宽度（信息区宽度随屏幕断点变化）
-     * @description 'ratio' - 比例布局（按设定比例分配宽度）
-     * @default 'fixed'
-     */
-    layoutMode?: BodyLayoutMode;
-    /**
-     * 内容区与信息区的比例
-     * @description 仅在 layoutMode='ratio' 时生效
-     * @example '7:3' - 内容区占 70%，信息区占 30%
-     * @default '7:3'
-     */
-    layoutRatio?: BodyLayoutRatio;
-    /** 内容区插槽 */
-    contentSlot?: ReactNode;
-    /** 内容区类名 */
-    contentClassName?: string;
-    /** 内容区样式 */
-    contentStyle?: CSSProperties;
-    /** 信息区插槽 */
-    sidebarSlot?: ReactNode;
-    /** 信息区类名 */
-    sidebarClassName?: string;
-    /** 信息区样式 */
-    sidebarStyle?: CSSProperties;
-    /**
-     * 信息区容器选择器（类名或 ID）
-     * @description 用于计算信息区高度的容器元素，支持类名（如 '.modal-container'）或 ID（如 '#dialog-container'）
-     * @description 如果不提供，则使用 window.innerHeight 作为基准
-     */
-    sidebarContainerSelector?: string;
-}
-/**
- * 底部操作区位置模式
- */
-export declare type FooterPositionMode = 'fixed-bottom' | 'fixed-content-bottom' | 'fixed-sidebar-bottom' | 'float-all' | 'float-content' | 'float-sidebar';
-/**
- * ProcedureFooter 底部区域配置
- */
-export interface ProcedureFooterProps {
-    /** 自定义类名 */
-    className?: string;
-    /** 自定义样式 */
-    style?: CSSProperties;
-    /**
-     * 左侧插槽
-     * @description 底部左侧区域，可放置自定义内容（如总价信息、提示文案等）
-     */
-    leftSlot?: ReactNode;
-    /**
-     * 右侧操作按钮组
-     * @description 底部右侧区域，放置操作按钮（如上一步、下一步、提交等）
-     */
-    actions?: ReactNode;
-    /**
-     * 移动端总结按钮插槽
-     * @description 当宽度小于744px时显示，点击可弹窗展示信息区内容
-     */
-    summaryButton?: ReactNode;
-    /**
-     * 移动端弹窗标题
-     * @description summaryButton 点击后弹窗的标题
-     * @default '详情'
-     */
-    summaryModalTitle?: string;
-    /**
-     * More 按钮文案
-     * @default 'More'
-     */
-    moreText?: string;
-    /**
-     * 是否启用溢出收纳功能
-     * @description 当宽度不足时，将次序列的按钮收纳到 More 菜单中
-     * @default true
-     */
-    enableOverflow?: boolean;
-    /**
-     * 底部操作区位置模式
-     * @description 控制底部操作区的展示位置
-     * @default 'float-sidebar'
-     */
-    position?: FooterPositionMode;
-}
-/**
- * 组件使用模式
- */
-export declare type ProcedureMode = 'page' | 'modal';
-/**
- * PisellProcedure 组件 Props
- * @description 流程容器组件，用于管理多步骤流程的复合容器
- */
-export interface PisellProcedureProps {
-    /**
-     * 自定义类名
-     */
-    className?: string;
-    /**
-     * 自定义样式
-     */
-    style?: CSSProperties;
-    /**
-     * 组件使用模式
-     * @description 'page' - 页面模式（默认），'modal' - 弹窗模式
-     * @description 弹窗模式下：不应用移动端模式、不隐藏信息部分、不设置底部为固定悬浮、不显示移动端总结按钮、不执行响应式类名计算
-     * @default 'page'
-     */
-    mode?: ProcedureMode;
-    /**
-     * 是否显示头部区域
-     * @default true
-     */
-    showHeader?: boolean;
-    /**
-     * 是否显示信息区（侧边栏）
-     * @default true
-     */
-    showSidebar?: boolean;
-    /**
-     * 是否显示底部区域
-     * @default true
-     */
-    showFooter?: boolean;
-    /**
-     * 默认当前步骤
-     * @default 0
-     */
-    defaultCurrent?: number;
-    /**
-     * 步骤变化回调
-     * @description 当步骤变化时触发，返回步骤变化结果
-     */
-    onStepsChange?: (result: StepChangeResult) => void;
-    /**
-     * 头部区域配置
-     */
-    headerProps?: ProcedureHeaderProps;
-    /**
-     * 主体区域配置
-     */
-    bodyProps?: ProcedureBodyProps;
-    /**
-     * 底部区域配置
-     */
-    footerProps?: ProcedureFooterProps;
-    /**
-     * 上一步事件回调
-     * @description 当触发上一步操作时调用（在步骤更新之前触发）
-     * @param current - 当前步骤索引
-     * @returns 返回 false 可以阻止步骤更新
-     */
-    onPrev?: (current: number) => boolean | void;
-    /**
-     * 下一步事件回调
-     * @description 当触发下一步操作时调用（在步骤更新之前触发）
-     * @param current - 当前步骤索引
-     * @returns 返回 false 可以阻止步骤更新
-     */
-    onNext?: (current: number) => boolean | void;
-    /**
-     * 首步返回按钮点击回调
-     * @description 当在第一步且 showBackOnFirstStep 为 true 时，点击返回按钮触发此回调。如果不传递，默认跳转到首页（/）
-     */
-    onFirstStepBack?: () => void;
-    /**
-     * 关闭按钮点击回调
-     */
-    onClose?: () => void;
-    /**
-     * 返回确认弹窗按钮回调
-     * @description 当点击返回确认弹窗的按钮时触发
-     * @param action - 'cancel' 点击清除按钮, 'ok'/'confirm' 点击保留按钮
-     */
-    onBackConfirm?: (action: 'cancel' | 'ok' | 'confirm') => void;
-    /**
-     * 关闭确认弹窗按钮回调
-     * @description 当点击关闭确认弹窗的按钮时触发
-     * @param action - 'cancel' 点击取消按钮, 'ok'/'confirm' 点击确认按钮
-     */
-    onCloseConfirm?: (action: 'cancel' | 'ok' | 'confirm') => void;
-    /**
-     * 设计模式标识
-     * @description 低代码引擎使用
-     */
-    __designMode?: 'design' | 'preview';
-    /**
-     * 组件唯一标识
-     * @description 低代码引擎使用
-     */
-    __id?: string;
-    /**
-     * 其他扩展配置
-     * @description 用于透传额外属性
-     */
-    other?: Record<string, any>;
-}

package/es/components/PisellProcedure/utils/classNames.d.ts

@@ -1,33 +0,0 @@
-/**
- * 类名合并工具函数
- * @description 用于合并多个类名，过滤掉 undefined、null、空字符串
- */
-/**
- * 合并类名
- * @param classNames 类名数组
- * @returns 合并后的类名字符串
- * @example
- * mergeClassNames('base', 'active', undefined, 'extra')
- * // => 'base active extra'
- */
-export declare const mergeClassNames: (...classNames: (string | undefined | null | false)[]) => string;
-/**
- * 生成带前缀的类名
- * @param prefix 前缀
- * @param suffix 后缀（可选）
- * @returns 类名字符串
- * @example
- * prefixClassName('pisell-procedure', 'header')
- * // => 'pisell-procedure-header'
- */
-export declare const prefixClassName: (prefix: string, suffix?: string) => string;
-/**
- * 生成带修饰符的 BEM 类名
- * @param block 块名
- * @param modifier 修饰符
- * @returns 类名字符串
- * @example
- * modifierClassName('pisell-procedure-footer', 'float-sidebar')
- * // => 'pisell-procedure-footer--float-sidebar'
- */
-export declare const modifierClassName: (block: string, modifier?: string) => string;

package/es/components/PisellProcedure/utils/extractText.d.ts

@@ -1,20 +0,0 @@
-import React from 'react';
-/**
- * 从 React 节点中提取文本内容
- * @param node React 节点
- * @returns 提取的文本字符串
- * @example
- * extractTextFromNode(<span>Hello</span>) // => 'Hello'
- * extractTextFromNode('Hello') // => 'Hello'
- * extractTextFromNode([<span>Hello</span>, ' ', <span>World</span>]) // => 'Hello World'
- */
-export declare const extractTextFromNode: (node: React.ReactNode) => string;
-/**
- * 从按钮 props 中提取显示文本
- * @param buttonProps 按钮的 props
- * @param fallback 默认文本
- * @returns 显示文本
- */
-export declare const extractButtonLabel: (buttonProps: {
-    children?: React.ReactNode;
-} | undefined, fallback: string) => string;

package/es/components/PisellProcedure/utils/footerPosition.d.ts

@@ -1,41 +0,0 @@
-import type { FooterPositionMode } from '../types';
-/**
- * 底部位置判断工具函数
- * @description 用于判断底部操作区的位置模式
- */
-/**
- * 判断底部是否在内容区
- * @param position 底部位置模式
- * @returns 是否在内容区
- */
-export declare const isFooterInContent: (position: FooterPositionMode) => boolean;
-/**
- * 判断底部是否在信息区
- * @param position 底部位置模式
- * @returns 是否在信息区
- */
-export declare const isFooterInSidebar: (position: FooterPositionMode) => boolean;
-/**
- * 判断底部是否全局显示
- * @param position 底部位置模式
- * @returns 是否全局显示
- */
-export declare const isFooterGlobal: (position: FooterPositionMode) => boolean;
-/**
- * 判断底部是否固定模式
- * @param position 底部位置模式
- * @returns 是否固定模式
- */
-export declare const isFooterFixed: (position: FooterPositionMode) => boolean;
-/**
- * 判断底部是否悬浮模式
- * @param position 底部位置模式
- * @returns 是否悬浮模式
- */
-export declare const isFooterFloat: (position: FooterPositionMode) => boolean;
-/**
- * 获取底部位置的目标区域
- * @param position 底部位置模式
- * @returns 目标区域: 'content' | 'sidebar' | 'global'
- */
-export declare const getFooterTargetArea: (position: FooterPositionMode) => 'content' | 'sidebar' | 'global';

package/es/components/PisellProcedure/utils/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * PisellProcedure 工具函数导出
- */
-export { mergeClassNames, prefixClassName, modifierClassName, } from './classNames';
-export { wrapSlotWithClick, isValidSlot, renderSlotOrDefault, } from './slotHelper';
-export { isFooterInContent, isFooterInSidebar, isFooterGlobal, isFooterFixed, isFooterFloat, getFooterTargetArea, } from './footerPosition';
-export { extractTextFromNode, extractButtonLabel, } from './extractText';
-export { parseLayoutRatio, calculateRatioPercent, generateRatioStyles, LAYOUT_RATIO_PRESETS, } from './layoutRatio';

package/es/components/PisellProcedure/utils/layoutRatio.d.ts

@@ -1,42 +0,0 @@
-import type { BodyLayoutRatio } from '../types';
-/**
- * 布局比例工具函数
- * @description 用于解析和计算内容区与信息区的布局比例
- */
-/**
- * 解析比例字符串
- * @param ratio 比例字符串，如 '7:3'
- * @returns [内容区比例, 信息区比例]
- * @example
- * parseLayoutRatio('7:3') // => [7, 3]
- * parseLayoutRatio('6:4') // => [6, 4]
- */
-export declare const parseLayoutRatio: (ratio: BodyLayoutRatio) => [number, number];
-/**
- * 计算百分比
- * @param ratio 比例字符串，如 '7:3'
- * @returns { contentPercent, sidebarPercent }
- * @example
- * calculateRatioPercent('7:3') // => { contentPercent: 70, sidebarPercent: 30 }
- */
-export declare const calculateRatioPercent: (ratio: BodyLayoutRatio) => {
-    contentPercent: number;
-    sidebarPercent: number;
-};
-/**
- * 生成 flex 比例样式
- * @param ratio 比例字符串，如 '7:3'
- * @param gap 间距（px）
- * @returns { contentStyle, sidebarStyle }
- */
-export declare const generateRatioStyles: (ratio: BodyLayoutRatio, gap?: number) => {
-    contentStyle: React.CSSProperties;
-    sidebarStyle: React.CSSProperties;
-};
-/**
- * 预设比例选项
- */
-export declare const LAYOUT_RATIO_PRESETS: {
-    label: string;
-    value: BodyLayoutRatio;
-}[];

package/es/components/PisellProcedure/utils/slotHelper.d.ts

@@ -1,27 +0,0 @@
-import React from 'react';
-/**
- * 插槽包装工具函数
- * @description 用于包装 React 插槽元素，添加额外的事件处理
- */
-/**
- * 包装插槽元素，添加点击事件
- * @param slotContent 插槽内容
- * @param onClick 点击回调
- * @returns 包装后的插槽内容
- * @example
- * wrapSlotWithClick(leftSlot, handleBackClick)
- */
-export declare const wrapSlotWithClick: (slotContent: React.ReactNode, onClick?: () => void | boolean) => React.ReactNode;
-/**
- * 检查插槽是否为有效的 React 元素
- * @param slotContent 插槽内容
- * @returns 是否为有效元素
- */
-export declare const isValidSlot: (slotContent: React.ReactNode) => boolean;
-/**
- * 渲染插槽内容，如果为空则返回默认内容
- * @param slotContent 插槽内容
- * @param defaultContent 默认内容
- * @returns 最终渲染内容
- */
-export declare const renderSlotOrDefault: (slotContent: React.ReactNode, defaultContent?: React.ReactNode) => React.ReactNode;

package/es/components/PisellScrollView/PisellScrollView.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import { PisellScrollViewProps, PisellScrollViewRef } from './types';
-import './PisellScrollView.less';
-declare const PisellScrollView: React.ForwardRefExoticComponent<Omit<PisellScrollViewProps, "ref"> & React.RefAttributes<PisellScrollViewRef>>;
-export default PisellScrollView;

package/es/components/PisellScrollView/PisellScrollView.stories.d.ts

@@ -1,87 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import PisellScrollView from './PisellScrollView';
-/**
- * PisellScrollView 滚动视图组件
- *
- * 提供丰富的滚动功能，包括滚动方向控制、滚动条样式、滚动按钮、滚动事件监听、
- * 视图监听、吸附滚动等功能
- */
-declare const meta: Meta<typeof PisellScrollView>;
-export default meta;
-declare type Story = StoryObj<typeof PisellScrollView>;
-/**
- * 基础用法 - 垂直滚动
- */
-export declare const Default: Story;
-/**
- * 水平滚动
- */
-export declare const HorizontalScroll: Story;
-/**
- * 双向滚动
- */
-export declare const BothDirections: Story;
-/**
- * 滚动条样式 - 细滚动条
- */
-export declare const ThinScrollbar: Story;
-/**
- * 滚动条样式 - 隐藏滚动条
- */
-export declare const HiddenScrollbar: Story;
-/**
- * 滚动按钮 - 右侧箭头
- */
-export declare const RightArrows: Story;
-/**
- * 滚动按钮 - 左右箭头
- */
-export declare const LeftRightArrows: Story;
-/**
- * 滚动按钮 - 返回顶部
- */
-export declare const BackToTop: Story;
-/**
- * 滚动事件监听
- */
-export declare const ScrollEvents: Story;
-/**
- * 吸附滚动 - 垂直方向
- */
-export declare const SnapScrollVertical: Story;
-/**
- * 吸附滚动 - 水平方向
- */
-export declare const SnapScrollHorizontal: Story;
-/**
- * 视图监听 - IntersectionObserver
- */
-export declare const IntersectionObserver: Story;
-/**
- * Ref 方法调用
- */
-export declare const RefMethods: Story;
-/**
- * 滚动到指定元素
- */
-export declare const ScrollToElement: Story;
-/**
- * 自定义尺寸
- */
-export declare const CustomSize: Story;
-/**
- * 综合示例 - 商品列表
- */
-export declare const ProductList: Story;
-/**
- * 综合示例 - 横向标签页
- */
-export declare const HorizontalTabs: Story;
-/**
- * 交互测试 - 验证组件渲染
- */
-export declare const RenderTest: Story;
-/**
- * 交互测试 - 滚动按钮点击
- */
-export declare const ScrollButtonTest: Story;

package/es/components/PisellScrollView/hooks/index.d.ts

@@ -1,3 +0,0 @@
-export * from './useScrollState';
-export * from './useScrollEvents';
-export * from './useIntersection';

package/es/components/PisellScrollView/hooks/useIntersection.d.ts

@@ -1,8 +0,0 @@
-import { RefObject } from 'react';
-import { PisellScrollViewProps } from '../types';
-interface UseIntersectionProps {
-    containerRef: RefObject<HTMLElement>;
-    config?: PisellScrollViewProps['intersection'];
-}
-export declare const useIntersection: ({ containerRef, config }: UseIntersectionProps) => void;
-export {};

package/es/components/PisellScrollView/hooks/useScrollEvents.d.ts

@@ -1,20 +0,0 @@
-import { RefObject } from 'react';
-import { ScrollEventData, PisellScrollViewProps } from '../types';
-interface UseScrollEventsProps {
-    containerRef: RefObject<HTMLElement>;
-    onScroll?: PisellScrollViewProps['onScroll'];
-    onScrollStart?: PisellScrollViewProps['onScrollStart'];
-    onScrollEnd?: PisellScrollViewProps['onScrollEnd'];
-    onReachTop?: PisellScrollViewProps['onReachTop'];
-    onReachBottom?: PisellScrollViewProps['onReachBottom'];
-    onReachLeft?: PisellScrollViewProps['onReachLeft'];
-    onReachRight?: PisellScrollViewProps['onReachRight'];
-    reachThreshold?: number;
-    scrollEndDelay?: number;
-    updateScrollState: () => void;
-    scrollState: ScrollEventData;
-}
-export declare const useScrollEvents: ({ containerRef, onScroll, onScrollStart, onScrollEnd, onReachTop, onReachBottom, onReachLeft, onReachRight, reachThreshold, scrollEndDelay, updateScrollState, scrollState, }: UseScrollEventsProps) => {
-    handleScroll: () => void;
-};
-export {};

package/es/components/PisellScrollView/hooks/useScrollState.d.ts

@@ -1,13 +0,0 @@
-import { RefObject } from 'react';
-import { ScrollEventData, PisellScrollViewProps } from '../types';
-/**
- * 滚动状态管理 Hook
- * @description 管理滚动容器的状态，包括滚动位置、溢出检测等
- */
-export declare const useScrollState: ({ containerRef, overflow, }: {
-    containerRef: RefObject<HTMLElement>;
-    overflow: PisellScrollViewProps['overflow'];
-}) => {
-    scrollState: ScrollEventData;
-    updateScrollState: () => void;
-};

package/es/components/PisellScrollView/index.d.ts

@@ -1,3 +0,0 @@
-import PisellScrollView from './PisellScrollView';
-export type { PisellScrollViewProps, PisellScrollViewRef } from './types';
-export default PisellScrollView;