@pisell/materials 6.11.16 → 6.11.17

package/es/components/pisellDateTimeDisplay/hooks/useCurrentTime.d.ts

@@ -0,0 +1,46 @@
+import { Dayjs } from 'dayjs';
+/**
+ * useCurrentTime Hook 配置项
+ */
+export interface UseCurrentTimeOptions {
+    /**
+     * 刷新间隔（毫秒）
+     * @default 60000
+     */
+    refreshInterval?: number;
+    /**
+     * 是否禁用自动刷新
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * dayjs locale
+     * @default 优先使用全局配置，其次使用 i18n 当前语言（getCurrentLocale）
+     * @example 'zh-CN' | 'zh-HK' | 'en' | 'en-US' | 'ja'
+     */
+    locale?: string;
+    /**
+     * 时间更新回调
+     */
+    onUpdate?: (time: Dayjs) => void;
+}
+/**
+ * 管理当前时间状态的自定义 Hook
+ *
+ * @description
+ * - 自动创建定时器刷新时间
+ * - 支持自定义刷新间隔
+ * - 支持国际化（locale）：优先级为 用户指定 > 全局配置 > i18n 当前语言
+ * - 组件卸载时自动清除定时器
+ *
+ * @example
+ * const currentTime = useCurrentTime({
+ *   refreshInterval: 1000,
+ *   locale: 'zh-CN',
+ *   onUpdate: (time) => console.log(time.format())
+ * });
+ *
+ * @param options 配置项
+ * @returns 当前时间（Dayjs 对象）
+ */
+export declare function useCurrentTime(options?: UseCurrentTimeOptions): Dayjs;

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

@@ -0,0 +1,3 @@
+export { default as PisellDateTimeDisplay } from './PisellDateTimeDisplay';
+export type { PisellDateTimeDisplayProps, LayoutDirection, DateOrder, TextAlign, FieldType, TimeFormatConfig, DateFormatConfig, WeekdayFormatConfig, FieldConfig, TextStyleConfig, ContainerStyleConfig, } from './types';
+export { default } from './PisellDateTimeDisplay';

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

@@ -0,0 +1,352 @@
+import type { CSSProperties } from 'react';
+import type { Dayjs } from 'dayjs';
+/**
+ * 布局方向
+ * - horizontal: 水平布局（默认）- 时间在上，日期+星期在下
+ * - vertical: 垂直布局 - 时间、日期、星期分别独立成行
+ * - inline: 单行布局 - 所有信息横向排列，用分隔符连接
+ */
+export declare type LayoutDirection = 'horizontal' | 'vertical' | 'inline';
+/**
+ * 日期顺序
+ * - YMD: 年-月-日（如：2026-03-21）
+ * - MDY: 月-日-年（如：Mar 21, 2026）
+ * - DMY: 日-月-年（如：21 Mar 2026）
+ */
+export declare type DateOrder = 'YMD' | 'MDY' | 'DMY';
+/**
+ * 对齐方式
+ */
+export declare type TextAlign = 'left' | 'center' | 'right';
+/**
+ * 字段类型
+ */
+export declare type FieldType = 'time' | 'date' | 'weekday';
+/**
+ * 时间格式配置
+ */
+export interface TimeFormatConfig {
+    /**
+     * 是否使用12小时制
+     * @default false
+     * @example true -> "1:45 PM" | false -> "13:45"
+     */
+    use12Hour?: boolean;
+    /**
+     * 是否显示秒
+     * @default false
+     * @example true -> "13:45:30" | false -> "13:45"
+     */
+    showSeconds?: boolean;
+    /**
+     * 小时是否补零
+     * @default false
+     * @example true -> "01:45 PM" | false -> "1:45 PM"
+     */
+    padHour?: boolean;
+    /**
+     * 是否只显示小时
+     * @default false
+     * @example true -> "13" | false -> "13:45"
+     */
+    onlyShowHour?: boolean;
+}
+/**
+ * 日期格式配置
+ */
+export interface DateFormatConfig {
+    /**
+     * 日期顺序
+     * @default 'YMD'
+     */
+    order?: DateOrder;
+    /**
+     * 英文月份是否简写
+     * @default true
+     * @example true -> "Mar" | false -> "March"
+     */
+    shortMonth?: boolean;
+    /**
+     * 英文月份是否数字展示
+     * @default false
+     * @example true -> "03" | false -> "Mar"
+     */
+    numericMonth?: boolean;
+    /**
+     * 中文是否显示"年月日"汉字
+     * @default false
+     * @example true -> "2026年3月21日" | false -> "2026-03-21"
+     */
+    showChineseUnit?: boolean;
+    /**
+     * 分隔符
+     * @default '-'
+     * @example '-' -> "2026-03-21" | '/' -> "2026/03/21"
+     */
+    separator?: string;
+    /**
+     * 是否显示年
+     * @default false
+     */
+    showYear?: boolean;
+    /**
+     * 是否显示月
+     * @default true
+     */
+    showMonth?: boolean;
+    /**
+     * 是否显示日
+     * @default true
+     */
+    showDay?: boolean;
+    /**
+     * 英文 DMY 时年月之间是否加逗号（如 21 Mar, 2026；false 时为 22 Jan 2025）
+     * @default true
+     */
+    useCommaBeforeYear?: boolean;
+    /**
+     * 是否在「今天/昨天/明天」时用相对日替换具体日期
+     * 开启后：与参考日同天显示「今天」，前一天「昨天」，后一天「明天」；其他日期仍按原格式
+     * @default false
+     */
+    showRelativeDay?: boolean;
+    /**
+     * 相对日文案覆盖（用于 i18n 或自定义）
+     * 不传时按 locale 使用默认：zh 今天/昨天/明天，en Today/Yesterday/Tomorrow
+     */
+    relativeDayLabels?: {
+        today?: string;
+        yesterday?: string;
+        tomorrow?: string;
+    };
+}
+/**
+ * 星期格式配置
+ */
+export interface WeekdayFormatConfig {
+    /**
+     * 是否完整展示
+     * @default false
+     * @example true -> "Saturday" / "星期六" | false -> "Sat" / "周六"
+     */
+    full?: boolean;
+    /**
+     * 是否单字母展示
+     * @default false
+     * @example true -> "S" / "六" | false -> "Sat" / "周六"
+     */
+    singleLetter?: boolean;
+    /**
+     * 是否在星期后加逗号（用于与日期拼接如 "Sat, 21 Mar, 2026"）
+     * @default false
+     */
+    trailingComma?: boolean;
+}
+/**
+ * 字段配置
+ */
+export interface FieldConfig {
+    /**
+     * 是否显示时间字段
+     * @default true
+     */
+    showTime?: boolean;
+    /**
+     * 是否显示日期字段
+     * @default true
+     */
+    showDate?: boolean;
+    /**
+     * 是否显示星期字段
+     * @default true
+     */
+    showWeekday?: boolean;
+    /**
+     * 字段顺序
+     * @default ['time', 'date', 'weekday']
+     */
+    fieldOrder?: FieldType[];
+    /**
+     * 单行布局时每段之间的分隔符，按顺序对应字段之间
+     * 如 ['date','time','weekday'] 配 inlineSeparators: [' - ', ' '] => "2025-12-31 - 2:00 周四"
+     * 不足时用组件 inlineSeparator 补齐
+     */
+    inlineSeparators?: string[];
+}
+/**
+ * 文本样式配置
+ */
+export interface TextStyleConfig {
+    /**
+     * 字体大小
+     * @example 14 | '14px' | '1rem'
+     */
+    fontSize?: number | string;
+    /**
+     * 字体粗细
+     * @example 400 | '400' | 'bold'
+     */
+    fontWeight?: number | string;
+    /**
+     * 字体颜色
+     * @example '#000' | 'rgba(0, 0, 0, 0.85)'
+     */
+    color?: string;
+    /**
+     * 行高
+     * @example 1.5 | '1.5' | '24px'
+     */
+    lineHeight?: number | string;
+}
+/**
+ * 容器样式配置
+ */
+export interface ContainerStyleConfig {
+    /**
+     * 背景色
+     * @example '#fff' | 'transparent'
+     */
+    background?: string;
+    /**
+     * 圆角
+     * @example 8 | '8px'
+     */
+    borderRadius?: number | string;
+    /**
+     * 边框
+     * @example '1px solid #ddd'
+     */
+    border?: string;
+    /**
+     * 阴影
+     * @example '0 2px 8px rgba(0, 0, 0, 0.1)'
+     */
+    boxShadow?: string;
+    /**
+     * 内边距
+     * @example 16 | '16px' | '16px 24px'
+     */
+    padding?: number | string;
+    /**
+     * 间距（子元素之间的间距）
+     * @example 8 | '8px'
+     */
+    gap?: number | string;
+}
+/**
+ * 多语言格式预设（日期/时间/星期 + 字段顺序与分隔符）
+ * 用于 formatByLocale[locale] 或默认多语言配置
+ */
+export interface DateTimeDisplayFormatPreset {
+    dateFormat?: DateFormatConfig;
+    timeFormat?: TimeFormatConfig;
+    weekdayFormat?: WeekdayFormatConfig;
+    fields?: FieldConfig;
+}
+/**
+ * PisellDateTimeDisplay 组件 Props
+ */
+export interface PisellDateTimeDisplayProps {
+    /**
+     * 传入时展示该时间，不传则展示当前时间（并可按 refreshInterval 刷新）
+     * @description 用于表格列、详情等展示给定时间；支持 dayjs、时间戳、ISO 字符串
+     */
+    value?: Dayjs | string | number;
+    /**
+     * 布局方向
+     * @default 'horizontal'
+     */
+    layout?: LayoutDirection;
+    /**
+     * 文本对齐方式
+     * @default 'center'
+     */
+    textAlign?: TextAlign;
+    /**
+     * 字段显示配置
+     */
+    fields?: FieldConfig;
+    /**
+     * 多语言格式配置：按 locale 取对应格式预设，再与下方单项配置合并（单项优先）
+     * @example formatByLocale={{ 'zh-cn': { dateFormat: {...}, fields: { fieldOrder: ['date','time','weekday'], inlineSeparators: [' - ', ' '] } }, 'en': {...} }}
+     */
+    formatByLocale?: Record<string, Partial<DateTimeDisplayFormatPreset>>;
+    /**
+     * 时间格式配置
+     */
+    timeFormat?: TimeFormatConfig;
+    /**
+     * 日期格式配置
+     */
+    dateFormat?: DateFormatConfig;
+    /**
+     * 星期格式配置
+     */
+    weekdayFormat?: WeekdayFormatConfig;
+    /**
+     * 自定义格式化字符串（优先级最高，类似 dayjs().format()）
+     * @example 'YYYY-MM-DD HH:mm:ss' | 'MM/DD/YYYY'
+     * @description 当设置此属性时，其他格式化配置将被忽略
+     */
+    customFormat?: string;
+    /**
+     * 单行模式分隔符
+     * @default ' · '
+     * @example ' | ' | ' - '
+     */
+    inlineSeparator?: string;
+    /**
+     * 容器样式
+     */
+    containerStyle?: ContainerStyleConfig;
+    /**
+     * 时间文本样式
+     */
+    timeStyle?: TextStyleConfig;
+    /**
+     * 日期文本样式
+     */
+    dateStyle?: TextStyleConfig;
+    /**
+     * 星期文本样式
+     */
+    weekdayStyle?: TextStyleConfig;
+    /**
+     * 自定义刷新间隔（毫秒）
+     * @description 不设置则根据 showSeconds 自动判断（显示秒=1000ms，否则=60000ms）
+     * @example 1000 | 5000 | 60000
+     */
+    refreshInterval?: number;
+    /**
+     * 是否禁用自动刷新
+     * @default false
+     * @description 设置为 true 时，组件只显示初始时间，不会自动更新
+     */
+    disableAutoRefresh?: boolean;
+    /**
+     * dayjs locale（语言代码）
+     * @default 优先使用全局配置（usePisellConfig），其次使用 i18n 当前语言（getCurrentLocale：全局配置 / umi_locale）
+     * @example 'zh-CN' | 'zh-HK' | 'en' | 'en-US' | 'ja'
+     * @description
+     * - 支持标准 BCP 47 语言代码，会自动标准化为 dayjs 兼容格式
+     * - 优先级：组件 locale 属性 > PisellConfigProvider 全局配置 > i18n 当前语言
+     */
+    locale?: string;
+    /**
+     * 自定义类名
+     */
+    className?: string;
+    /**
+     * 自定义样式
+     */
+    style?: CSSProperties;
+    /**
+     * 时间更新回调
+     * @param currentTime 当前时间（Dayjs 对象）
+     */
+    onTimeUpdate?: (currentTime: Dayjs) => void;
+    /**
+     * 点击回调
+     */
+    onClick?: () => void;
+}

package/es/components/pisellDateTimeDisplay/utils/formatDate.d.ts

@@ -0,0 +1,21 @@
+import type { Dayjs } from 'dayjs';
+import type { DateFormatConfig } from '../types';
+/**
+ * 格式化日期
+ * @param date dayjs 日期对象
+ * @param config 日期格式配置
+ * @returns 格式化后的日期字符串
+ *
+ * @example
+ * // 英文环境
+ * formatDate(dayjs(), { order: 'YMD', shortMonth: true, showYear: true })
+ * // => "2026-Mar-21"
+ *
+ * // 中文环境
+ * formatDate(dayjs(), { order: 'YMD', showChineseUnit: true, showYear: true })
+ * // => "2026年3月21日"
+ *
+ * formatDate(dayjs(), { order: 'MDY', shortMonth: false, showYear: true })
+ * // => "March 21, 2026"
+ */
+export declare function formatDate(date: Dayjs, config?: DateFormatConfig): string;

package/es/components/pisellDateTimeDisplay/utils/formatDateOrRelative.d.ts

@@ -0,0 +1,17 @@
+import type { Dayjs } from 'dayjs';
+import type { DateFormatConfig, WeekdayFormatConfig } from '../types';
+/**
+ * 获取「日期部分」的展示文案（相对日内置在 datetime）
+ * - 若开启 showRelativeDay 且日期为今天/昨天/明天，返回相对日文案（如「今天」「Yesterday」）
+ * - 否则返回「星期, 日期」格式（用于时间区间跨天等场景）
+ *
+ * 供 PisellDateTimeDisplay、PisellTimeRangeDisplay 等统一使用，相对时间逻辑只在此处维护
+ */
+export declare function getDatePartDisplay(params: {
+    date: Dayjs;
+    dateFormat?: DateFormatConfig;
+    weekdayFormat?: WeekdayFormatConfig;
+    referenceDate: Dayjs;
+    /** 覆盖日期格式（如跨天时的 order: 'DMY', shortMonth: true） */
+    dateFormatOverride?: Partial<DateFormatConfig>;
+}): string;

package/es/components/pisellDateTimeDisplay/utils/formatTime.d.ts

@@ -0,0 +1,19 @@
+import type { Dayjs } from 'dayjs';
+import type { TimeFormatConfig } from '../types';
+/**
+ * 格式化时间
+ * @param time dayjs 时间对象
+ * @param config 时间格式配置
+ * @returns 格式化后的时间字符串
+ *
+ * @example
+ * formatTime(dayjs(), { use12Hour: false, showSeconds: false, padHour: false })
+ * // => "13:45"
+ *
+ * formatTime(dayjs(), { use12Hour: true, showSeconds: false, padHour: true })
+ * // => "01:45 PM"
+ *
+ * formatTime(dayjs(), { use12Hour: false, showSeconds: true, padHour: false })
+ * // => "13:45:30"
+ */
+export declare function formatTime(time: Dayjs, config?: TimeFormatConfig): string;

package/es/components/pisellDateTimeDisplay/utils/formatWeekday.d.ts

@@ -0,0 +1,30 @@
+import type { Dayjs } from 'dayjs';
+import type { WeekdayFormatConfig } from '../types';
+/**
+ * 格式化星期
+ * @param weekday dayjs 日期对象
+ * @param config 星期格式配置
+ * @returns 格式化后的星期字符串
+ *
+ * @example
+ * // 英文环境
+ * formatWeekday(dayjs(), { full: false, singleLetter: false })
+ * // => "Sat"
+ *
+ * formatWeekday(dayjs(), { full: true })
+ * // => "Saturday"
+ *
+ * formatWeekday(dayjs(), { singleLetter: true })
+ * // => "S"
+ *
+ * // 中文环境
+ * formatWeekday(dayjs(), { full: false, singleLetter: false })
+ * // => "周六"
+ *
+ * formatWeekday(dayjs(), { full: true })
+ * // => "星期六"
+ *
+ * formatWeekday(dayjs(), { singleLetter: true })
+ * // => "六"
+ */
+export declare function formatWeekday(weekday: Dayjs, config?: WeekdayFormatConfig): string;

package/es/components/pisellDateTimeDisplay/utils/getRefreshInterval.d.ts

@@ -0,0 +1,18 @@
+import type { TimeFormatConfig } from '../types';
+/**
+ * 根据时间格式配置计算刷新间隔
+ * @param timeFormat 时间格式配置
+ * @returns 刷新间隔（毫秒）
+ *
+ * @description
+ * - 显示秒时：1000ms (1秒刷新一次)
+ * - 不显示秒时：60000ms (60秒刷新一次)
+ *
+ * @example
+ * getRefreshInterval({ showSeconds: true })
+ * // => 1000
+ *
+ * getRefreshInterval({ showSeconds: false })
+ * // => 60000
+ */
+export declare function getRefreshInterval(timeFormat?: TimeFormatConfig): number;

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

@@ -0,0 +1,7 @@
+export { formatTime } from './formatTime';
+export { formatDate } from './formatDate';
+export { formatWeekday } from './formatWeekday';
+export { getDatePartDisplay } from './formatDateOrRelative';
+export { getRefreshInterval } from './getRefreshInterval';
+export { getRelativeDay, getRelativeDayLabel, type RelativeDay, } from './relativeDay';
+export { normalizeLocale, isChinese, getDayjsLocale, } from './localeUtils';

package/es/components/pisellDateTimeDisplay/utils/localeUtils.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 标准化 locale 代码
+ * @param locale 原始 locale 代码
+ * @returns 标准化后的 locale 代码（小写，用于 dayjs）
+ * @example 'zh-CN' -> 'zh-cn', 'en' -> 'en'
+ */
+export declare function normalizeLocale(locale: string): string;
+/**
+ * 判断是否为中文环境
+ * @param locale locale 代码
+ * @returns 是否为中文
+ * @example isChinese('zh-CN') -> true, isChinese('zh-HK') -> true, isChinese('en') -> false
+ */
+export declare function isChinese(locale: string): boolean;
+/**
+ * 获取 dayjs 兼容的 locale 代码
+ * 未传 locale 时：优先 materials 当前语言（globalConfig / umi_locale），若为默认 en-US 则用 @pisell/utils getLocale
+ * @param locale 原始 locale 代码（可选）
+ * @returns dayjs 兼容的 locale 代码（与已加载的 zh-cn、en 对齐）
+ * @example 'zh-CN' -> 'zh-cn', 'en-US' -> 'en'
+ */
+export declare function getDayjsLocale(locale?: string): string;

package/es/components/pisellDateTimeDisplay/utils/relativeDay.d.ts

@@ -0,0 +1,24 @@
+import type { Dayjs } from 'dayjs';
+export declare type RelativeDay = 'today' | 'yesterday' | 'tomorrow';
+/**
+ * 判断日期相对于参考日期是今天、昨天还是明天
+ *
+ * @param date 要展示的日期
+ * @param reference 参考日期（通常为「当前」dayjs()）
+ * @returns 'today' | 'yesterday' | 'tomorrow' | null
+ *
+ * @example
+ * getRelativeDay(dayjs(), dayjs())           // => 'today'
+ * getRelativeDay(dayjs().add(1,'day'), dayjs()) // => 'tomorrow'
+ * getRelativeDay(dayjs().subtract(1,'day'), dayjs()) // => 'yesterday'
+ */
+export declare function getRelativeDay(date: Dayjs, reference: Dayjs): RelativeDay | null;
+/**
+ * 根据 locale 返回相对日期的展示文案
+ * 未传 locale 时使用 getDayjsLocale()（与 locales.getLocale 同源）
+ *
+ * @param day 'today' | 'yesterday' | 'tomorrow'
+ * @param locale dayjs locale，如 'zh-cn'、'en'
+ * @returns 如 '今天'、'Today'
+ */
+export declare function getRelativeDayLabel(day: RelativeDay, locale?: string): string;

package/es/components/pisellDraggable/components/Remove/Remove.d.ts

@@ -1,3 +1,3 @@
-/// <reference types="react" />
+import React from 'react';
 import { ActionProps } from '../Action';
-export declare function Remove(props: ActionProps): JSX.Element;
+export declare function Remove(props: ActionProps): React.JSX.Element;

package/es/components/pisellDraggable/components/TreeItem/SortableTreeItem.d.ts

@@ -5,5 +5,5 @@ interface Props extends TreeItemProps {
     id: UniqueIdentifier;
     __designMode?: string;
 }
-declare const _default: React.MemoExoticComponent<({ id, depth, ...props }: Props) => JSX.Element>;
+declare const _default: React.MemoExoticComponent<({ id, depth, ...props }: Props) => React.JSX.Element>;
 export default _default;

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

@@ -30,6 +30,6 @@ interface Props {
     /** 自定义拖拽判断函数，返回false时阻止拖拽 */
     canDrop?: (dragItem: FlattenedItem, dropTarget: FlattenedItem, parentId: UniqueIdentifier | null, parentNode: any) => boolean;
 }
-export declare function SortableTree({ collapsible, value, indicator, indentationWidth, removable, renderItem, onChange, onRemoveBefore, __designMode, maxLevel, canDrop, }: Props): JSX.Element;
-declare const Demo: (props: Props) => JSX.Element;
+export declare function SortableTree({ collapsible, value, indicator, indentationWidth, removable, renderItem, onChange, onRemoveBefore, __designMode, maxLevel, canDrop, }: Props): React.JSX.Element;
+declare const Demo: (props: Props) => React.JSX.Element;
 export default Demo;

package/es/components/pisellDropSort/components/SortableItem/index.d.ts

@@ -22,5 +22,5 @@ interface SortableItemProps {
     /** 获取item样式 */
     getItemStyle?: (itemProps: TreeItem) => React.CSSProperties;
 }
-declare const SortableItem: (props: SortableItemProps) => JSX.Element;
+declare const SortableItem: (props: SortableItemProps) => React.JSX.Element;
 export default SortableItem;

package/es/components/pisellEmail/PisellEmail.d.ts

@@ -0,0 +1,37 @@
+import React from 'react';
+import type { PisellEmailProps } from './types';
+import './PisellEmail.less';
+/**
+ * PisellEmail 邮箱地址组件
+ *
+ * 邮箱地址输入/展示组件，支持只读、编辑、禁用三种状态。
+ * 基于 Ant Design AutoComplete 和 Input 组件开发，提供邮箱格式校验、域名智能补全、
+ * mailto 邮件发送和域名隐藏功能。
+ *
+ * @param props 组件 Props
+ *
+ * @example
+ * // 编辑态（邮箱输入）
+ * <PisellEmail
+ *   placeholder="请输入邮箱地址"
+ *   required
+ * />
+ *
+ * @example
+ * // 只读态（可发邮件）
+ * <PisellEmail
+ *   mode="read"
+ *   value="user@example.com"
+ *   enableMailto
+ * />
+ *
+ * @example
+ * // 域名补全
+ * <PisellEmail
+ *   enableAutoComplete
+ *   autoCompleteDomains={['gmail.com', 'company.com']}
+ * />
+ */
+export declare const PisellEmail: React.FC<PisellEmailProps>;
+declare const _default: React.NamedExoticComponent<PisellEmailProps>;
+export default _default;