@pisell/materials 6.11.16 → 6.11.18

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

@@ -0,0 +1,237 @@
+import type { CSSProperties, ReactNode } from 'react';
+/**
+ * 布局模式
+ */
+export declare type BatchActionBarPosition = 'sticky-top' | 'sticky-bottom' | 'float' | 'inline';
+/**
+ * 确认弹窗配置
+ */
+export interface BatchActionConfirmConfig {
+    /**
+     * 弹窗标题
+     */
+    title?: string;
+    /**
+     * 弹窗描述内容
+     */
+    description?: string;
+    /**
+     * 确认按钮文案
+     */
+    okText?: string;
+    /**
+     * 取消按钮文案
+     */
+    cancelText?: string;
+}
+/**
+ * 默认操作按钮配置
+ * @description 固定四个基础操作按钮：全选、反选、取消选择、删除
+ */
+export interface DefaultActionsConfig {
+    /**
+     * 是否显示默认操作按钮（全选、反选、取消选择、删除）
+     * @default true
+     */
+    showDefaultActions?: boolean;
+    /**
+     * 是否显示全选按钮
+     * @default true
+     */
+    showSelectAll?: boolean;
+    /**
+     * 是否显示反选按钮
+     * @default true
+     */
+    showInvert?: boolean;
+    /**
+     * 是否显示取消选择按钮
+     * @default true
+     */
+    showClear?: boolean;
+    /**
+     * 是否显示删除按钮
+     * @default true
+     */
+    showDelete?: boolean;
+}
+/**
+ * 自定义操作按钮配置
+ */
+export interface BatchActionItem {
+    /**
+     * 操作唯一标识
+     */
+    key: string;
+    /**
+     * 按钮文案
+     */
+    label: ReactNode;
+    /**
+     * 按钮图标
+     */
+    icon?: ReactNode;
+    /**
+     * 按钮尺寸
+     * @description 对应 GraphicTextCard 的 size 属性
+     * @default 'small'
+     */
+    size?: 'small' | 'default' | 'large';
+    /**
+     * 是否禁用
+     * @description 支持函数形式，基于 selection 动态判断
+     */
+    disabled?: boolean | ((selectedKeys: React.Key[], selectedRows?: any[]) => boolean);
+    /**
+     * 是否显示
+     * @description 支持函数形式，基于 selection 动态判断
+     * @default true
+     */
+    visible?: boolean | ((selectedKeys: React.Key[], selectedRows?: any[]) => boolean);
+    /**
+     * 是否显示 loading 状态
+     */
+    loading?: boolean;
+    /**
+     * 是否需要确认弹窗
+     * @default false
+     */
+    confirm?: boolean | BatchActionConfirmConfig;
+    /**
+     * 自定义样式
+     */
+    style?: CSSProperties;
+    /**
+     * 自定义类名
+     */
+    className?: string;
+    /**
+     * 按钮组标识
+     * @description 相同 group 的按钮会分组展示
+     */
+    group?: string;
+    /**
+     * 按钮点击回调
+     * @description 如果配置了此回调，会优先使用此回调，否则使用组件级别的 onActionClick
+     */
+    onClick?: (selectedKeys: React.Key[], selectedRows?: any[]) => void | Promise<void>;
+}
+/**
+ * PisellBatchActionBar 组件 Props
+ * @description 批量操作栏组件，用于承载基于选中对象的批量行为操作
+ */
+export interface PisellBatchActionBarProps {
+    /**
+     * 自定义类名
+     */
+    className?: string;
+    /**
+     * 自定义样式
+     */
+    style?: CSSProperties;
+    /**
+     * 选中的 key 数组
+     * @description 必填，用于感知选择状态
+     */
+    selectedKeys: React.Key[];
+    /**
+     * 选中的行数据数组
+     * @description 可选，用于传递给操作回调
+     */
+    selectedRows?: any[];
+    /**
+     * 总数据量
+     * @description 用于判断全选状态
+     */
+    total?: number;
+    /**
+     * 当前页数据量
+     * @description 用于判断全选当前页状态
+     */
+    currentPageTotal?: number;
+    /**
+     * 当前页数据 key 数组
+     * @description 用于判断全选当前页状态
+     */
+    currentPageKeys?: React.Key[];
+    /**
+     * 布局模式
+     * @default 'float'
+     */
+    position?: BatchActionBarPosition;
+    /**
+     * 吸顶/吸底时的偏移量
+     * @default 0
+     */
+    offset?: number;
+    /**
+     * 是否显示选中数量提示
+     * @default true
+     */
+    showSelectedCount?: boolean;
+    /**
+     * 选中数量提示文案
+     * @description 支持字符串模板（使用 {count} 占位符）或函数形式，默认使用国际化文本
+     * @default getText('batch-action-bar-selected-count', count)
+     */
+    selectedCountText?: string | ((count: number) => string);
+    /**
+     * 默认操作按钮配置
+     * @description 只包含前三个基础选择操作按钮，其他操作按钮通过 actions 传入
+     */
+    defaultActions?: DefaultActionsConfig;
+    /**
+     * 自定义操作按钮配置
+     */
+    actions?: BatchActionItem[];
+    /**
+     * 操作按钮排序
+     * @description 通过 key 数组控制按钮顺序
+     */
+    actionOrder?: string[];
+    /**
+     * 是否启用溢出折叠
+     * @default true
+     */
+    enableOverflow?: boolean;
+    /**
+     * 溢出折叠阈值（按钮数量）
+     * @default 5
+     */
+    overflowThreshold?: number;
+    /**
+     * "更多"按钮文案
+     * @description 默认使用国际化文本
+     * @default getText('batch-action-bar-more')
+     */
+    moreText?: string;
+    /**
+     * 全选回调
+     */
+    onSelectAll?: () => void;
+    /**
+     * 反选回调
+     * @description 反选操作，将当前选中的变为未选中，未选中的变为选中
+     */
+    onInvert?: () => void;
+    /**
+     * 清空选择回调
+     */
+    onClear?: () => void;
+    /**
+     * 删除回调
+     * @description 删除选中项，点击后会先弹出确认弹窗
+     */
+    onDelete?: (selectedKeys: React.Key[], selectedRows?: any[]) => void;
+    /**
+     * 删除确认弹窗配置
+     * @description 自定义删除确认弹窗的标题和内容
+     */
+    deleteConfirmConfig?: BatchActionConfirmConfig;
+    /**
+     * 自定义操作按钮点击回调
+     * @description 当 actions 中的按钮被点击时触发，通过 action.key 区分不同的操作
+     * @description 如果 action 中配置了 onClick，则优先使用 action.onClick
+     */
+    onActionClick?: (key: string, selectedKeys: React.Key[], selectedRows?: any[]) => void | Promise<void>;
+}

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

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import React from 'react';
 import { CardProps } from 'antd';
 import './index.less';
 export interface PisellCardProps extends CardProps {
@@ -16,5 +16,5 @@ export interface PisellCardProps extends CardProps {
  * @param props
  * @constructor
  */
-declare const PisellCard: (props: PisellCardProps) => JSX.Element;
+declare const PisellCard: (props: PisellCardProps) => React.JSX.Element;
 export default PisellCard;

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

@@ -36,5 +36,5 @@ export interface PisellCheckboxGroupProps extends React.HTMLAttributes<HTMLDivEl
  * @Author: zhiwei.Wang
  * @Date: 2024-08-16 10:34
  */
-declare const PisellCheckboxGroup: (props: PisellCheckboxGroupProps) => JSX.Element;
+declare const PisellCheckboxGroup: (props: PisellCheckboxGroupProps) => React.JSX.Element;
 export default PisellCheckboxGroup;

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

@@ -20,5 +20,5 @@ export declare type PisellCountdownProps = React.HTMLAttributes<HTMLSpanElement>
     /** 格式化倒计时展示 参考 dayjs */
     format?: string;
 };
-declare const PisellCountdown: (props: PisellCountdownProps) => JSX.Element;
+declare const PisellCountdown: (props: PisellCountdownProps) => React.JSX.Element;
 export default PisellCountdown;

package/lib/components/pisellCurrency/PisellCurrency.d.ts

@@ -0,0 +1,39 @@
+import React from 'react';
+import type { PisellCurrencyProps } from './types';
+import './PisellCurrency.less';
+/**
+ * PisellCurrency 货币组件
+ *
+ * 基于 PisellNumber 派生，专门处理货币数据。
+ * 默认启用千分位和2位小数，符合财务规范。
+ *
+ * @param props 组件 Props
+ *
+ * @example
+ * // 受控模式
+ * const [price, setPrice] = useState(0);
+ * <PisellCurrency
+ *   value={price}
+ *   onChange={setPrice}
+ *   currencySymbol="¥"
+ * />
+ *
+ * @example
+ * // 非受控模式
+ * <PisellCurrency
+ *   defaultValue={100}
+ *   currencySymbol="$"
+ * />
+ *
+ * @example
+ * // 只读态
+ * <PisellCurrency
+ *   mode="read"
+ *   value={1234.56}
+ *   currencySymbol="¥"
+ * />
+ * // 显示: ¥1,234.56
+ */
+export declare const PisellCurrency: React.FC<PisellCurrencyProps>;
+declare const MemoizedPisellCurrency: React.NamedExoticComponent<PisellCurrencyProps>;
+export default MemoizedPisellCurrency;

package/lib/components/pisellCurrency/PisellCurrency.stories.d.ts

@@ -0,0 +1,56 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { PisellCurrency } from './PisellCurrency';
+/**
+ * PisellCurrency 组件 Storybook
+ */
+declare const meta: Meta<typeof PisellCurrency>;
+export default meta;
+declare type Story = StoryObj<typeof PisellCurrency>;
+/**
+ * 基础示例 - 人民币
+ */
+export declare const Basic: Story;
+/**
+ * 不同货币
+ */
+export declare const DifferentCurrencies: Story;
+/**
+ * 只读态展示
+ */
+export declare const ReadOnly: Story;
+/**
+ * 禁用态
+ */
+export declare const Disabled: Story;
+/**
+ * 不显示货币符号
+ */
+export declare const WithoutSymbol: Story;
+/**
+ * 禁止负数（商品价格）
+ */
+export declare const NoNegative: Story;
+/**
+ * 允许负数（退款金额）
+ */
+export declare const AllowNegative: Story;
+/**
+ * 表单场景
+ */
+export declare const InForm: Story;
+/**
+ * 表格场景
+ */
+export declare const InTable: Story;
+/**
+ * 不同精度
+ */
+export declare const DifferentPrecision: Story;
+/**
+ * 只读态样式
+ */
+export declare const ReadOnlyStyles: Story;
+/**
+ * 空值处理
+ */
+export declare const EmptyValue: Story;

package/lib/components/pisellCurrency/components/DisabledView.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { PisellCurrencyProps } from '../types';
+/**
+ * PisellCurrency 禁用态视图组件
+ *
+ * 负责渲染禁用态的输入框
+ *
+ * @param props 组件 Props
+ */
+declare const DisabledView: React.FC<PisellCurrencyProps>;
+export default DisabledView;

package/lib/components/pisellCurrency/components/EditView.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import type { PisellCurrencyProps } from '../types';
+/**
+ * PisellCurrency 编辑态视图组件
+ *
+ * 负责渲染编辑态的输入框，基于 Ant Design InputNumber 组件
+ *
+ * 功能：
+ * - 货币数值输入
+ * - 货币符号显示（prefix 或 addonAfter）
+ * - 负数校验
+ * - 实时或失焦校验
+ * - 错误提示展示
+ *
+ * @param props 组件 Props
+ */
+declare const EditView: React.FC<PisellCurrencyProps>;
+export default EditView;

package/lib/components/pisellCurrency/components/ReadOnlyView.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+import type { PisellCurrencyProps } from '../types';
+/**
+ * PisellCurrency 只读态视图组件
+ *
+ * 负责渲染只读态的纯文本展示
+ *
+ * 功能：
+ * - 格式化货币数值并展示
+ * - 添加货币符号（无空格）
+ * - 支持自定义字体样式
+ * - 处理空值显示
+ *
+ * @param props 组件 Props
+ */
+declare const ReadOnlyView: React.FC<PisellCurrencyProps>;
+export default ReadOnlyView;

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

@@ -0,0 +1,6 @@
+/**
+ * PisellCurrency 子组件导出
+ */
+export { default as ReadOnlyView } from './ReadOnlyView';
+export { default as EditView } from './EditView';
+export { default as DisabledView } from './DisabledView';

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

@@ -0,0 +1,7 @@
+/**
+ * PisellCurrency 组件导出
+ */
+import PisellCurrency from './PisellCurrency';
+export { PisellCurrency };
+export type { PisellCurrencyProps } from './types';
+export type { DisplayState, ValidationResult, NumberInputState, BaseNumberInputProps } from './types';

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

@@ -0,0 +1,56 @@
+import type { PisellNumberProps } from '../pisellNumber';
+/**
+ * 从 @pisell/utils 重新导出公共类型
+ */
+export type { DisplayState, ValidationResult, NumberInputState, BaseNumberInputProps, } from '@pisell/utils';
+/**
+ * PisellCurrency 组件 Props 类型定义
+ *
+ * 基于 PisellNumber 扩展，专门处理货币数据
+ */
+export interface PisellCurrencyProps extends PisellNumberProps {
+    /**
+     * 货币符号
+     * @default '¥'
+     * @example '¥', '$', '€', '£', '₩', '₽'
+     */
+    currencySymbol?: string;
+    /**
+     * 货币符号位置
+     * - before: 前置，如 ¥100
+     * - after: 后置，如 100€
+     * @default 'before'
+     */
+    symbolPosition?: 'before' | 'after';
+    /**
+     * 是否显示货币符号
+     * @default true
+     */
+    showSymbol?: boolean;
+    /**
+     * 货币代码（用于国际化标识）
+     * @example 'CNY', 'USD', 'EUR', 'GBP'
+     */
+    currencyCode?: string;
+    /**
+     * 是否允许负数
+     * @default true
+     * @description
+     * - true: 允许负数（如退款场景）
+     * - false: 不允许负数（如商品价格）
+     */
+    allowNegative?: boolean;
+    /**
+     * 小数精度
+     * @default 2
+     * @description 货币默认保留2位小数，符合财务规范
+     */
+    precision?: number;
+    /**
+     * 是否使用千分位分隔符
+     * @default true
+     * @description 货币默认启用千分位，符合财务规范
+     * @example 1234.56 → 1,234.56
+     */
+    useGrouping?: boolean;
+}

package/lib/components/pisellCurrency/utils/currencyFormatter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 货币格式化选项
+ */
+export interface CurrencyFormatOptions {
+    /** 货币符号 */
+    currencySymbol: string;
+    /** 符号位置 */
+    symbolPosition: 'before' | 'after';
+    /** 是否显示符号 */
+    showSymbol: boolean;
+    /** 小数精度 */
+    precision: number;
+    /** 是否使用千分位 */
+    useGrouping: boolean;
+}
+/**
+ * 格式化货币数值
+ *
+ * @param value 数值
+ * @param options 格式化选项
+ * @returns 格式化后的货币字符串
+ *
+ * @example
+ * formatCurrency(1234.56, { currencySymbol: '¥', symbolPosition: 'before', showSymbol: true, precision: 2, useGrouping: true })
+ * // 返回: '¥1,234.56'
+ *
+ * @example
+ * formatCurrency(999.99, { currencySymbol: '€', symbolPosition: 'after', showSymbol: true, precision: 2, useGrouping: true })
+ * // 返回: '999.99€'
+ */
+export declare function formatCurrency(value: number | null | undefined, options: CurrencyFormatOptions): string | null;

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

@@ -0,0 +1,5 @@
+/**
+ * PisellCurrency 工具函数导出
+ */
+export { formatCurrency } from './currencyFormatter';
+export type { CurrencyFormatOptions } from './currencyFormatter';

package/lib/components/pisellDataSourceContainer/PisellDataSourceContainer.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { DataSourceContainerProps } from './type';
+declare const PisellDataSourceContainer: (props: DataSourceContainerProps) => React.JSX.Element;
+export default PisellDataSourceContainer;

package/lib/components/pisellDataSourceContainer/components/ColumnsSetting/index.d.ts

@@ -0,0 +1,28 @@
+import React from 'react';
+import { DataSourceContainerContextType } from '../../type';
+export declare const COLUMNS_SHARED_STATE_KEYS: {
+    readonly columnsValue: (instanceId: string) => string;
+    readonly columnsChange: (instanceId: string) => string;
+};
+export interface ColumnsSettingProps {
+    scopeId?: string;
+    __id?: string;
+}
+export interface ColumnSettingItem {
+    key: string;
+    title: React.ReactNode;
+    titleString?: string;
+    dataIndex: string;
+    isShow: boolean;
+    sortIndex?: number;
+    fixed?: 'left' | 'right' | boolean;
+}
+/**
+ * 暴露给父组件的 ref 方法
+ */
+export interface ColumnsSettingRef {
+}
+declare const _default: React.ForwardRefExoticComponent<Omit<ColumnsSettingProps & DataSourceContainerContextType & React.RefAttributes<ColumnsSettingRef> & {
+    refId?: string | undefined;
+}, "ref"> & React.RefAttributes<any>>;
+export default _default;

package/lib/components/pisellDataSourceContainer/components/ColumnsSetting/utils.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 列设置工具：持久化复用 @pisell/utils 的 saveColumnSettingToLocal / getColumnSettingFromLocal；
+ * mergeColumnSettingSimple 为 Table 列与本地缓存的合并逻辑，保留在此。
+ */
+import React from 'react';
+import { getColumnSettingFromLocal, clearColumnSettingFromLocal } from '@pisell/utils';
+export { getColumnSettingFromLocal, clearColumnSettingFromLocal };
+/** 与 DataSourceContainer ColumnsSetting 调用处类型兼容的列设置项（含 React.ReactNode title） */
+export interface ColumnSettingItemForSave {
+    key: string;
+    dataIndex: string;
+    title?: React.ReactNode;
+    titleString?: string;
+    isShow: boolean;
+    sortIndex?: number;
+    fixed?: 'left' | 'right' | boolean;
+}
+export declare const saveColumnSettingToLocal: (params: {
+    componentId: string;
+    columnSetting: ColumnSettingItemForSave[];
+}) => void;
+export declare const mergeColumnSettingSimple: ({ columns, componentId, }: {
+    columns: Record<string, any>[];
+    componentId?: string | undefined;
+}) => {
+    isShow: any;
+    sortIndex: any;
+}[];

package/lib/components/pisellDataSourceContainer/components/Filter/FilterButton.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { FormInstance } from 'antd';
+import { DataSourceContainerContextType } from '../../type';
+declare const _default: React.ForwardRefExoticComponent<Omit<Partial<import("../../../filter/components/FilterButton/types").FilterListProps> & DataSourceContainerContextType & FormInstance<any> & React.RefAttributes<unknown> & {
+    refId?: string | undefined;
+}, "ref"> & React.RefAttributes<any>>;
+export default _default;

package/lib/components/pisellDataSourceContainer/components/Filter/QuickFilter.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { FormInstance } from 'antd';
+import { DataSourceContainerContextType } from '../../type';
+declare const _default: React.ForwardRefExoticComponent<Omit<Partial<{
+    filterList: import("../../../filter/types").FilterItemProps[];
+    formFiltersPrefix?: string | undefined;
+}> & DataSourceContainerContextType & FormInstance<any> & React.RefAttributes<unknown> & {
+    refId?: string | undefined;
+}, "ref"> & React.RefAttributes<any>>;
+export default _default;

package/lib/components/pisellDataSourceContainer/components/Filter/index.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { FormInstance } from 'antd';
+import { DataSourceContainerContextType } from '../../type';
+declare const _default: React.ForwardRefExoticComponent<Omit<Partial<{
+    value: {
+        quickFilter?: import("../../../filter/types").FilterItemProps[] | undefined;
+        otherFilter?: import("../../../filter/types").FilterItemProps[] | undefined;
+    };
+    formFiltersPrefix?: string | undefined;
+    quickFilterMaxLength?: number | undefined;
+}> & DataSourceContainerContextType & FormInstance<any> & React.RefAttributes<unknown> & {
+    refId?: string | undefined;
+}, "ref"> & React.RefAttributes<any>>;
+export default _default;

package/lib/components/pisellDataSourceContainer/components/Pagination/index.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { DataSourceContainerContextType } from '../../type';
+declare const _default: React.ForwardRefExoticComponent<Omit<Partial<import("antd").PaginationProps> & DataSourceContainerContextType & React.RefAttributes<unknown> & {
+    refId?: string | undefined;
+}, "ref"> & React.RefAttributes<any>>;
+export default _default;

package/lib/components/pisellDataSourceContainer/components/Sort/index.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { FormInstance } from 'antd';
+import { DataSourceContainerContextType } from '../../type';
+declare const _default: React.ForwardRefExoticComponent<Omit<Partial<import("../../../sort/types").SortListProps> & DataSourceContainerContextType & {
+    name?: string | undefined;
+} & FormInstance<any> & React.RefAttributes<unknown> & {
+    refId?: string | undefined;
+}, "ref"> & React.RefAttributes<any>>;
+export default _default;

package/lib/components/pisellDataSourceContainer/components/Table/index.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { DataSourceContainerContextType } from '../../type';
+declare const _default: React.ForwardRefExoticComponent<Omit<Partial<import("antd").TableProps<any>> & DataSourceContainerContextType & {
+    scopeId?: string | undefined;
+    __id?: string | undefined;
+} & React.RefAttributes<unknown> & {
+    refId?: string | undefined;
+}, "ref"> & React.RefAttributes<any>>;
+export default _default;

package/lib/components/pisellDataSourceContainer/components/Table/useColumns.d.ts

@@ -0,0 +1,14 @@
+import { RefManagerContextType } from '../../type';
+/**
+ * useColumns Hook 参数
+ */
+interface UseColumnsParams {
+    columns: any[];
+    scopeId: string;
+    refManager: RefManagerContextType;
+    __id?: string;
+}
+declare const useColumns: (params: UseColumnsParams) => {
+    visibleColumns: any[];
+};
+export default useColumns;

package/lib/components/pisellDataSourceContainer/hooks/useContainerContext.d.ts

@@ -0,0 +1,3 @@
+import { UseContainerContextReturnType } from '../type';
+declare const useContainerContext: (displayName?: string) => UseContainerContextReturnType;
+export default useContainerContext;