@pisell/materials 3.3.88 → 3.3.89

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

@@ -0,0 +1,268 @@
+import { FilterType } from "../filter/types";
+import { SortItemProps } from "../sort/types";
+import React from "react";
+export declare type StorageMode = "" | "localStorage";
+/**
+ * 排序总配置
+ */
+export declare type SortType = {
+    /** 排序是否展示 */
+    show: boolean;
+    /** 排序存储模式 */
+    storageMode: StorageMode;
+    list: SortItemProps[];
+};
+/**
+ * 列展示总配置
+ */
+export declare type ColumnSettingType = {
+    /** 列设置是否展示 */
+    show: boolean;
+    /** 列设置存储模式 */
+    storageMode: StorageMode;
+};
+declare type DataSourceListItemType = {
+    isCustom: boolean;
+    columnKey?: string;
+    label?: string;
+    name?: string | string[];
+    isHidden?: boolean;
+};
+/**
+ * 数据源分组总配置
+ */
+export declare type DataSourceGroupType = {
+    /** 分组设置是否展示 */
+    show: boolean;
+    /** 分组设置存储模式 */
+    storageMode: StorageMode;
+    /**  */
+    list: DataSourceListItemType[];
+};
+/**
+ * Gallery封面总配置
+ */
+declare type GalleryCoverType = {
+    /** 封面是否展示 */
+    show: boolean;
+    /**
+     * 封面图片可以使用的字段
+     */
+    fields: string[];
+    /**
+     * 封面高度
+     */
+    height: number;
+    /** 图片裁剪方式 */
+    objectFit: "fill" | "cover";
+};
+/**
+ * Gallery标题总配置
+ */
+declare type GalleryTitleType = {
+    /** 标题使用的字段 */
+    field: string;
+    /** 标题行数 */
+    line: number;
+};
+/**
+ * Gallery头部区域总配置
+ */
+declare type GalleryHeaderType = {
+    /** 头部区域插槽 */
+    slot?: (record: Record<string, any>, index: number) => React.ReactNode;
+    /** 头部区域其他字段设置 */
+    fields: {
+        /** 头部区域其他字段是否展示 */
+        show: boolean;
+        /** 头部区域其他字段 */
+        list: string[];
+    };
+};
+/**
+ * Gallery内容区域总配置
+ */
+declare type GalleryContentType = {
+    /** 内容区域字段配置 */
+    fields: {
+        columnKey: string;
+        show: boolean;
+    }[];
+};
+export declare type GallerySettingValueType = {
+    coverField: string | "noCover";
+    coverObjectFit: "fill" | "cover";
+    compactMode: "default" | "compact";
+    isShowLabel: boolean;
+};
+/**
+ * Gallery底部区域总配置
+ */
+declare type GalleryFooterType = {
+    /** 底部区域自定义渲染 */
+    render: (record: Record<string, any>, index: number) => React.ReactNode;
+    /** 底部区域高度 */
+    height: number;
+};
+/**
+ * Gallery模式总配置
+ */
+export declare type GallerySettingType = {
+    /** 卡片最小宽度 */
+    cardMinWidth: number;
+    /** 卡片最大宽度 */
+    cardMaxWidth: number;
+    /** 水平间隔 */
+    horizontalGutter: number;
+    /** 垂直间隔 */
+    verticalGutter: number;
+    /** 封面配置 */
+    cover: GalleryCoverType;
+    /** 标题配置 */
+    title: GalleryTitleType;
+    /** 头部区域 */
+    header: GalleryHeaderType;
+    /** 内容区域 */
+    content: GalleryContentType;
+    /** 固定高度 */
+    fixedHeight: boolean;
+    /** 固定的卡片高度 */
+    cardHeight: number;
+    /** 固定顶部 */
+    fixedHeader: boolean;
+    /** 固定底部 */
+    fixedFooter: boolean;
+    /** 底部区域 */
+    footer: GalleryFooterType;
+    /** 卡片点击时间 */
+    onItem: (record: Record<string, any>, index: number) => void;
+};
+/** 视图模式 */
+export declare type ModeType = "grid" | "gallery" | "kanban";
+/**
+ * 视图模式总配置
+ */
+export declare type GridViewType = {
+    /** 默认视图模式 */
+    defaultViewMode: ModeType;
+    /** 开启多视图模式可进行页面内转换 */
+    multiple: boolean;
+    /** 当前可用的视图模式列表 */
+    modeList: ModeType[];
+};
+declare type SortDetail = {
+    fromIndex: number;
+    toIndex: number;
+    dataSource: Record<string, any>[];
+    fromId: number | string;
+    toId: number | string;
+    fromItem: Record<string, any>;
+    toItem: Record<string, any>;
+};
+/** 导入导出模式 */
+export declare type ExportImportModeType = "import" | "export" | "export_file" | "import_log";
+/**
+ * @title: 导出导入api
+ * @description:
+ * @return {*}
+ * @Author: WangHan
+ * @Date: 2024-09-11 15:44
+ */
+export declare type ApiProps = {
+    export?: string;
+    import?: string;
+    export_file: string;
+    import_log?: string;
+    template?: string;
+};
+/**
+ * 导入导出配置
+ */
+export declare type ExportImportType = {
+    /** 是否展示 */
+    show: boolean;
+    /** 当前所选项 */
+    selectLists: string[];
+    /** 导入模版链接 */
+    templateFileUrl: string;
+    /** 标题 */
+    title: string;
+    hiddenKeys?: string[];
+    apiUrl?: ApiProps;
+    otherParams?: any;
+};
+/**
+ * 设置记忆范围
+ */
+export declare type LocalSettingsScope = "filters" | "sorting" | "columns";
+/**
+ * 本地记忆设置
+ */
+export declare type LocalSettingsType = {
+    /** 启用设置记忆 */
+    enable: boolean;
+    /** 记忆范围 */
+    scope: LocalSettingsScope[];
+    /** 不需要记忆的筛选字段（当 scope 包含 filters 时生效） */
+    excludedFilterFields?: string[];
+};
+export declare type GridViewProps = {
+    columns: any;
+    dataSource: any[];
+    dispatch: any;
+    /**
+     * 画册模式的配置
+     */
+    gallery: GallerySettingType;
+    /**
+     * 视图设置
+     */
+    view: GridViewType;
+    style: React.CSSProperties;
+    pagination: any;
+    filter: FilterType;
+    buttons: React.ReactNode | any[];
+    actionButtons: any;
+    sort: SortType;
+    title?: React.ReactNode | (() => React.ReactNode);
+    showTitle?: boolean;
+    subTitle?: React.ReactNode | (() => React.ReactNode);
+    showSubTitle?: boolean;
+    exportImport: ExportImportType;
+    onValuesChange: (changedValues: any, values: any) => void;
+    summary: any;
+    utils: any;
+    rowKey: ((record: Record<string, any>) => string) | string;
+    columnSetting?: ColumnSettingType;
+    dataSourceGroup?: DataSourceGroupType;
+    loading: boolean;
+    dragSort: boolean;
+    onSortChange?: (detail: SortDetail) => boolean;
+    __id?: string;
+    __designMode?: "design";
+    /**
+     * 当前本地配置的key 用此hash是否改变用来判断是否清空本地配置 不填默认使用columns数据生成hash
+     */
+    currentSettingKey?: string;
+    /**
+    * 当前本地配置的唯一值, 不填默认使用currentSettingKey
+    */
+    currentComponentId?: string;
+    /**
+     * 当前表格中数据发生变化事件 包含本地筛选和外部传入数据变化
+     * @param currentDataSource
+     */
+    onDataSourceChange?: (currentDataSource: Record<string, any>[]) => void;
+    tabs: {
+        show: boolean;
+        type: 'default' | 'button' | 'buttonGroup' | 'dropdown';
+        items: {
+            name: string;
+            filterBy?: Record<string, any>;
+            sortBy?: string;
+        }[];
+    };
+    /** 本地记忆设置 */
+    localSettings?: LocalSettingsType;
+};
+export {};

package/es/components/time-picker/index.d.ts

@@ -1,2 +1,3 @@
+/// <reference types="react" />
 declare const TimePicker: (props: any) => import("react").JSX.Element;
 export default TimePicker;

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

@@ -0,0 +1,17 @@
+import React from 'react';
+import './index.less';
+declare type Value = {
+    en: string;
+    'zh-CN': string;
+    'zh-HK': string;
+    'ja': string;
+    'pt': string;
+};
+interface TranslationProps {
+    value: Value;
+    onChange: (value: Value) => void;
+    maxLength?: number;
+    id?: string;
+}
+declare const Translation: React.FC<TranslationProps>;
+export default Translation;

package/es/components/translation/utils.d.ts

@@ -0,0 +1,9 @@
+export declare const locales: {
+    en: string;
+    "zh-CN": string;
+    "zh-HK": string;
+    ja: string;
+    pt: string;
+};
+export declare const checkIfAllValuesAreEqual: (obj: any) => boolean;
+export declare const createTranslationText: (text: string, isAll?: boolean) => any;

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

@@ -1,2 +1,3 @@
+/// <reference types="react" />
 declare const Upload: (props: any) => import("react").JSX.Element;
 export default Upload;

package/es/components/virtual-keyboard/Time/utils.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 export declare const formatStringToTime: (value: string) => {
     valueArray: string[];
     valueString: string;

package/es/components/virtualInput/BaseVirtualInput/index.d.ts

@@ -0,0 +1,44 @@
+import React from 'react';
+import './index.less';
+export interface BaseVirtualInputProps {
+    /** 输入值 */
+    value?: string | React.ReactNode;
+    /** 占位符 */
+    placeholder?: string;
+    /** 是否自动聚焦 */
+    autoFocus?: boolean;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 组件高度，默认60px */
+    height?: number | string;
+    /** 字体大小，默认48px，如果不设置会根据高度自动计算 */
+    fontSize?: number | string;
+    /** 聚焦回调 */
+    onFocus?: () => void;
+    /** 失焦回调 */
+    onBlur?: () => void;
+    /** 文字位置 */
+    textAlign?: 'start' | 'center' | 'end';
+    /** 自定义样式 */
+    style?: React.CSSProperties;
+    /** 自定义类名 */
+    className?: string;
+    /** showCursor  */
+    showCursor?: boolean;
+    /** 防止失焦的元素选择器或ref */
+    preventBlurElements?: Array<string | React.RefObject<HTMLElement>>;
+    /** 是否聚焦（受控模式） */
+    focused?: boolean;
+    /** 是否选中全部文本（类似浏览器选中效果） */
+    selected?: boolean;
+    /** 选中状态的背景色，默认为主题色 */
+    selectedColor?: string;
+}
+export interface BaseVirtualInputRef {
+    /** 手动聚焦 */
+    focus: () => void;
+    /** 手动失焦 */
+    blur: () => void;
+}
+declare const BaseVirtualInput: React.ForwardRefExoticComponent<BaseVirtualInputProps & React.RefAttributes<BaseVirtualInputRef>>;
+export default BaseVirtualInput;

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

@@ -0,0 +1,29 @@
+import React from 'react';
+import { BaseVirtualInputProps, BaseVirtualInputRef } from './BaseVirtualInput';
+import './index.less';
+export type { BaseVirtualInputProps, BaseVirtualInputRef } from './BaseVirtualInput';
+export interface VirtualInputProps extends BaseVirtualInputProps {
+    /** 在VirtualInput上方显示的额外内容 */
+    topContent?: React.ReactNode;
+    /** 在VirtualInput下方显示的额外内容 */
+    bottomContent?: React.ReactNode;
+    /** wrapper class */
+    wrapperClassName?: string;
+    /** 虚拟输入框包装器的样式 */
+    wrapperStyle?: React.CSSProperties;
+    /** 是否允许清除输入框中的内容 */
+    allowClear?: boolean;
+    /** 清除输入框内容的回调函数 */
+    onClear?: () => void;
+    /** 自定义清除按钮的样式 */
+    clearButtonStyle?: React.CSSProperties;
+    theme?: {
+        token?: {
+            colorPrimary?: string;
+        };
+    };
+}
+export interface VirtualInputRef extends BaseVirtualInputRef {
+}
+declare const VirtualInput: React.ForwardRefExoticComponent<VirtualInputProps & React.RefAttributes<VirtualInputRef>>;
+export default VirtualInput;

package/es/hooks/useMobile.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 响应式监听 Hook
+ * 监听窗口大小变化，返回当前是否为移动端
+ *
+ * @param breakpoint - 断点宽度（默认 768px）
+ * @returns 是否为移动端
+ */
+export declare function useMobile(breakpoint?: number): boolean;

package/es/hooks/useThemeTokens.d.ts

@@ -0,0 +1,7 @@
+declare type ThemeInput = {
+    token?: {
+        colorPrimary?: string;
+    };
+};
+declare const useThemeTokens: (themeInput?: ThemeInput) => any;
+export default useThemeTokens;

package/es/theme/tokens.d.ts

@@ -0,0 +1,22 @@
+import { ThemeConfig } from 'antd';
+/**
+ * Pisell 项目统一的 Ant Design Token 配置
+ * 基于 Figma 设计规范
+ *
+ * 使用场景：
+ * - 低代码平台（page/index.tsx）
+ * - Storybook 预览
+ * - 其他需要主题配置的场景
+ */
+/**
+ * 获取组件级别的 token 配置
+ */
+export declare function getComponentsToken(): ThemeConfig['components'];
+/**
+ * 获取全局 token 配置
+ */
+export declare function getGlobalToken(themeColor?: string): ThemeConfig['token'];
+/**
+ * 获取完整的主题配置
+ */
+export declare function getThemeConfig(themeColor?: string): ThemeConfig;

package/es/utils/tagColor.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 只读态 Tag 未传 color 时使用的预设色板（按索引稳定分配）
+ */
+/**
+ * 根据 value 或索引从预设色板取一个稳定颜色（未传 option.color 时使用）
+ */
+export declare function getDefaultTagColor(value: unknown, index: number): string;

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

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { PisellBasicGridProps } from './types';
+import './PisellBasicGrid.less';
+/**
+ * 使用 memo 优化组件性能
+ * @description 当 props 没有变化时，避免不必要的重新渲染
+ */
+declare const MemoizedPisellBasicGrid: <T>(props: PisellBasicGridProps<T>) => React.JSX.Element;
+export { MemoizedPisellBasicGrid as PisellBasicGrid };
+export default MemoizedPisellBasicGrid;

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

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

package/lib/components/PisellBasicGrid/hooks/useGridStyle.d.ts

@@ -0,0 +1,37 @@
+import type { DirectionType, WrapType, JustifyType, AlignType, AlignContentType, UseGridStyleReturn } from '../types';
+/**
+ * useGridStyle Hook 参数
+ */
+interface UseGridStyleParams {
+    /** 排列方向 */
+    direction?: DirectionType;
+    /** 换行控制 */
+    wrap?: WrapType;
+    /** 一行显示的元素个数 */
+    columns?: number;
+    /** 是否等分容器宽度 */
+    equalWidth?: boolean;
+    /** 统一间距 */
+    gap?: number | string;
+    /** 行间距 */
+    rowGap?: number | string;
+    /** 列间距 */
+    columnGap?: number | string;
+    /** 主轴对齐方式 */
+    justify?: JustifyType;
+    /** 交叉轴对齐方式 */
+    align?: AlignType;
+    /** 多行对齐方式 */
+    alignContent?: AlignContentType;
+}
+/**
+ * 计算 Grid 布局样式的 Hook
+ * @param params - 布局参数
+ * @returns 容器样式和子元素样式
+ * @description
+ * - 根据传入的布局参数计算容器的 flex 样式
+ * - 根据 columns 和 gap 计算子元素的 flex-basis
+ * - 使用 useMemo 缓存计算结果，避免不必要的重复计算
+ */
+export declare const useGridStyle: (params: UseGridStyleParams) => UseGridStyleReturn;
+export default useGridStyle;

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

@@ -0,0 +1,6 @@
+/**
+ * PisellBasicGrid 组件导出
+ * @description 基于 Flexbox 的基础布局组件
+ */
+export { PisellBasicGrid, default } from './PisellBasicGrid';
+export type { PisellBasicGridProps, DirectionType, WrapType, JustifyType, AlignType, AlignContentType, BreakpointType, ResponsiveConfig, } from './types';