@pisell/materials 1.0.1007 → 1.0.1009

package/lib/components/table/Table/utils.d.ts

@@ -0,0 +1,167 @@
+import { GroupValue } from "../Actions/component/Group/PopoverContent";
+import { FilterItemProps, FilterType } from "../../filter/types";
+import { ColumnSettingType, DataSourceGroupType, GallerySettingValueType, ModeType, SortType } from "../types";
+export declare const getHash: (obj: any) => any;
+export declare const calcFilterSort: ({ dataSource, filter, sort, columns }: any) => any;
+/**
+ * 合并列设置
+ * @param defaultColumns 默认列设置
+ * @param tableId 表ID
+ * @returns 合并后的列设置
+ */
+export declare const mergeColumnSetting: ({ columns, tableId, currentViewMode, }: {
+    columns: Record<string, any>[];
+    tableId?: string | undefined;
+    currentViewMode: ModeType;
+}) => {
+    isShow: boolean;
+}[] | ({
+    width: any;
+    isShow: any;
+    sortIndex: number;
+} | {
+    isShow: boolean;
+    sortIndex: number;
+})[];
+/**
+ * 对数据源进行排序
+ * @param dataSource 数据源数组
+ * @param sortObj 排序对象，包含排序的键、值和类型
+ * @returns 排序后的数据源数组
+ */
+export declare const sortDataSource: (dataSource: Record<string, any>[], sortObj: {
+    sortKey: string;
+    sortValue: "asc" | "desc";
+    sortType: "date" | "string" | "number";
+}) => Record<string, any>[];
+/**
+ * 根据行键获取 ID
+ * @param item 记录对象
+ * @param rowKey 行键，可以是字符串或函数
+ * @returns 返回 ID
+ */
+export declare const getIdByRowKey: (item: Record<string, any>, rowKey: string | ((params: any) => string)) => any;
+/**
+ * 根据分组条件对数据源进行分组
+ * @param dataSource 数据源
+ * @param group 分组条件
+ * @param rowKey 行键生成函数或字符串
+ * @returns 返回分组后的数据源
+ */
+export declare const groupDataSource: (dataSource: Record<string, any>[], group: GroupValue, rowKey: string | ((params: any) => string)) => Record<string, any>[];
+declare type ViewSetting = {
+    order_by: string;
+    group_by: GroupValue;
+    column_setting: Record<string, any>[];
+    gallery_setting: GallerySettingValueType;
+    filters: any;
+    filter_setting: {
+        quickFilter: FilterItemProps[];
+        otherFilter: FilterItemProps[];
+    };
+};
+/**
+ * 本地存储的表格设置对象
+ */
+declare type TableSettingObjType = {
+    view_mode: ModeType;
+    currentSettingHash: string;
+} & {
+    [K in ModeType]: ViewSetting;
+};
+/**
+ * 将表格设置保存到本地存储
+ * @param tableId 表格id
+ * @param tableSettingObj 表格设置对象
+ */
+export declare const setTableSettingToLocalStorage: ({ tableId, tableSettingObj, currentViewMode, currentSettingHash, }: {
+    tableId: string;
+    tableSettingObj: Partial<ViewSetting & {
+        view_mode: ModeType;
+    }>;
+    currentViewMode: ModeType;
+    currentSettingHash: string;
+}) => {
+    key: string;
+    value: Record<string, any>;
+} | undefined;
+export declare const clearTableSettingToLocalStorage: (tableId?: string) => void;
+/**
+ * 从本地存储中获取表格设置, 全部配置
+ * @param tableId 表格ID
+ * @returns 表格设置对象
+ */
+export declare const getTableSettingFromLocalStorage: (tableId?: string) => Partial<TableSettingObjType>;
+/**
+ * 从LocalStorage读取表当前视图模式
+ * @param tableId
+ */
+export declare const getCurrentViewModeFromLocalStorage: (tableId?: string) => ModeType | undefined;
+/**
+ * 根据视图模式获取配置
+ * @param tableId
+ * @param currentViewMode
+ */
+export declare const getTableSettingByCurrentViewMode: (tableId: string, currentViewMode: ModeType) => ViewSetting | undefined;
+/**
+ * 将表单值保存到本地存储中
+ * @param tableId 表单ID
+ * @param allValues 表单所有值
+ * @param keys 存储的键名
+ */
+export declare const setFormValuesToLocalStorage: ({ tableId, allValues, keys, currentViewMode, currentSettingHash, }: {
+    tableId?: string | undefined;
+    allValues?: Record<string, any> | undefined;
+    keys?: string[] | undefined;
+    currentViewMode: ModeType;
+    currentSettingHash: string;
+}) => {
+    key: string;
+    value: Record<string, any>;
+} | undefined;
+/**
+ * 合并筛选设置
+ * @param list 列表数据
+ * @param quickFilterMaxLength 快速筛选最大长度
+ * @param tableId 表ID
+ * @returns 返回合并后的筛选设置
+ */
+export declare const mergeFilterSetting: ({ list, quickFilterMaxLength, tableId, sortButtonShow, currentViewMode, }: {
+    list: FilterItemProps[];
+    quickFilterMaxLength: number;
+    tableId?: string | undefined;
+    sortButtonShow: boolean;
+    currentViewMode: ModeType;
+}) => {
+    quickFilter: FilterItemProps[];
+    otherFilter: FilterItemProps[];
+    notSortFilter: FilterItemProps[];
+};
+/**
+ * 过滤数据源
+ * @param dataSource 数据源
+ * @param filters 过滤条件
+ * @param filterLocalArr 本地过滤项
+ * @returns 过滤后的数据源
+ */
+export declare const filterDataSource: (dataSource: Record<string, any>[], filters: Record<string, any>, filterLocalArr: FilterItemProps[]) => Record<string, any>[];
+/**
+ * 根据模式获取设置键数组
+ * @param filter 筛选器
+ * @param columnSetting 列设置
+ * @param dataSourceGroup 数据源分组
+ * @param sort 排序
+ * @param mode 模式，可选值为 "localStorage" 或 "remote"
+ * @returns 返回设置键数组
+ */
+export declare const getSettingKeyArrByMode: ({ filter, columnSetting, dataSourceGroup, sort, mode, currentViewMode, }: {
+    filter?: FilterType | undefined;
+    columnSetting?: ColumnSettingType | undefined;
+    dataSourceGroup?: DataSourceGroupType | undefined;
+    sort?: SortType | undefined;
+    mode: "" | "localStorage" | "remote";
+    currentViewMode: ModeType;
+}) => ("filters" | "order_by" | "group_by" | "column_setting" | "gallery_setting" | "filter_setting" | "view_mode")[];
+export declare const omit: (obj: Record<string, any>, keys: string[]) => Record<string, any>;
+export declare const stringify: (obj: Record<string, any>) => string;
+export {};

package/lib/components/table/hooks/useTableSetting.d.ts

@@ -0,0 +1,21 @@
+import { FilterType } from "../../filter/types";
+import { ColumnSettingType, DataSourceGroupType, GallerySettingType, GridViewType, ModeType, SortType, ExportImportModeType, LocalSettingsType } from "../types";
+declare type UseTableSettingProps = {
+    tableId?: string;
+    filter: FilterType;
+    columns: Record<string, any>[];
+    columnSetting?: ColumnSettingType;
+    dataSourceGroup?: DataSourceGroupType;
+    sort?: SortType;
+    view: GridViewType;
+    currentViewMode: ModeType;
+    gallery?: GallerySettingType;
+    currentSettingHash: string;
+    exportImport?: ExportImportModeType;
+    localSettings?: LocalSettingsType;
+};
+declare const useTableSetting: (params: UseTableSettingProps) => {
+    setTableSetting: (values: Record<string, any>) => void;
+    tableSetting: any;
+};
+export default useTableSetting;

package/lib/components/table/hooks/useTransDataSource.d.ts

@@ -0,0 +1,12 @@
+import { FormInstance } from "antd/es/form";
+import { FilterType } from "../../filter/types";
+declare type UseTransDataSourceParams = {
+    form: FormInstance;
+    localPagination: boolean;
+    dataSource: Record<string, any>[];
+    rowKey: string | ((params: any) => string);
+    filter: FilterType;
+    currentView: 'gallery' | 'table';
+};
+declare const useTransDataSource: (params: UseTransDataSourceParams) => Record<string, any>[];
+export default useTransDataSource;

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

@@ -0,0 +1,4 @@
+import React from 'react';
+import './index.less';
+declare const _default: React.ForwardRefExoticComponent<Omit<any, "ref"> & React.RefAttributes<unknown>>;
+export default _default;

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

@@ -0,0 +1,270 @@
+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;
+    }[];
+    /** 是否展示标题 */
+    showLabel?: 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/lib/components/translation/index.d.ts

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

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

@@ -0,0 +1,24 @@
+import React from 'react';
+import { Version } from '../versionSelect';
+import './index.less';
+interface PublishVersionModalProps {
+    visible: boolean;
+    currentVersion: string;
+    onCancel: () => void;
+    onConfirm: (data: VersionData) => void;
+    isShowNote?: boolean;
+    confirmLoading?: boolean;
+    versions?: Version[];
+    isShowBasedOn?: boolean;
+    isShowCurrentVersion?: boolean;
+    isValidateVersion?: boolean;
+    title: string;
+}
+interface VersionData {
+    version: string;
+    note: string;
+    baseVersion?: string;
+    versionType?: string;
+}
+declare const PublishVersionModal: React.FC<PublishVersionModalProps>;
+export default PublishVersionModal;

package/lib/components/virtual-keyboard/Amount/index.d.ts

@@ -0,0 +1,5 @@
+import { AmountProps, RightItemsStyleProps } from './types';
+import './index.less';
+export type { AmountProps, RightItemsStyleProps };
+declare const Amount: (props: AmountProps) => JSX.Element;
+export default Amount;

package/lib/components/virtual-keyboard/Amount/themeConfig.d.ts

@@ -0,0 +1,32 @@
+export declare const amountThemeConfig: {
+    dark: {
+        backgroundColor: string;
+        containerBackgroundColor: string;
+        buttonBackgroundColor: string;
+        textColor: string;
+        resetButtonBackgroundColor: string;
+        resetButtonTextColor: string;
+        isDoneButtonFollowTheme: boolean;
+        doneButtonBackgroundColor: string;
+        doneButtonTextColor: string;
+        keyboardBackgroundColor: string;
+        keyboardButtonBackgroundColor: string;
+        keyboardButtonTextColor: string;
+        keyboardButtonHoverColor: string;
+    };
+    light: {
+        backgroundColor: string;
+        containerBackgroundColor: string;
+        buttonBackgroundColor: string;
+        textColor: string;
+        resetButtonBackgroundColor: string;
+        resetButtonTextColor: string;
+        isDoneButtonFollowTheme: boolean;
+        doneButtonBackgroundColor: string;
+        doneButtonTextColor: string;
+        keyboardBackgroundColor: string;
+        keyboardButtonBackgroundColor: string;
+        keyboardButtonTextColor: string;
+        keyboardButtonHoverColor: string;
+    };
+};

package/lib/components/virtual-keyboard/Amount/types.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="react" />
+import { BaseNumberKeyboardProps } from '../BaseNumberKeyboard';
+export interface RightItemsStyleProps {
+    buttonBackgroundColor?: string;
+    textColor?: string;
+    resetButtonBackgroundColor?: string;
+    resetButtonTextColor?: string;
+    isDoneButtonFollowTheme?: boolean;
+    doneButtonBackgroundColor?: string;
+    doneButtonTextColor?: string;
+}
+export interface AmountProps {
+    max?: number;
+    min?: number;
+    doneText?: string;
+    resetText?: string;
+    defaultValue?: string | number;
+    placeholder?: string;
+    amountProps?: {
+        showCurrencySymbol: boolean;
+        useThousandsSeparator: boolean;
+    };
+    presets?: BaseNumberKeyboardProps['presets'];
+    value?: string | number;
+    onChange?: (val: string | number) => void;
+    onEnter?: (val: string | number) => void;
+    defaultSelect?: boolean;
+    inputFormat?: (_v: string) => React.ReactNode | null;
+    rightItemsStyle?: RightItemsStyleProps;
+    selectType?: 'light' | 'dark';
+    backgroundColor?: string;
+    containerBackgroundColor?: string;
+    buttonBackgroundColor?: string;
+    textColor?: string;
+    resetButtonBackgroundColor?: string;
+    resetButtonTextColor?: string;
+    isDoneButtonFollowTheme?: boolean;
+    doneButtonBackgroundColor?: string;
+    doneButtonTextColor?: string;
+    keyboardBackgroundColor?: string;
+    keyboardButtonBackgroundColor?: string;
+    keyboardButtonTextColor?: string;
+    keyboardButtonHoverColor?: string;
+}

package/lib/components/virtual-keyboard/BaseNumberKeyboard/Presets.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import './Presets.less';
+export declare type PresetsItem = {
+    label: string;
+    value: number | string;
+    style?: React.CSSProperties;
+    onClick?: (item: PresetsItem, _next: () => void) => void;
+    render?: (item: PresetsItem) => React.ReactNode;
+};
+export interface PresetsProps {
+    presets?: PresetsItem[];
+    onChange: (val: string) => void;
+}
+declare const Presets: (props: PresetsProps) => JSX.Element | null;
+export default Presets;

package/lib/components/virtual-keyboard/BaseNumberKeyboard/index.d.ts

@@ -0,0 +1,25 @@
+import React from 'react';
+import { PresetsProps } from './Presets';
+import { KeyboardProps } from '../Keyboard';
+import { RightItemsStyleProps } from '../Amount';
+import './index.less';
+export interface BaseNumberKeyboardProps {
+    placeholder?: string;
+    format?: (val: string) => React.ReactNode;
+    defaultValue?: string | number;
+    doneText?: string;
+    resetText?: string;
+    onChange?: (val: string) => void;
+    onEnter?: (val: string) => void;
+    value?: string | number;
+    max?: number;
+    min?: number;
+    presets?: PresetsProps['presets'];
+    defaultSelect?: boolean;
+    rightItemsStyle?: RightItemsStyleProps;
+    customDisplay?: React.ReactNode | ((props: any) => React.ReactNode);
+    keyboardProps?: KeyboardProps;
+    style?: React.CSSProperties;
+}
+declare const BaseNumberKeyboard: (props: BaseNumberKeyboardProps) => JSX.Element;
+export default BaseNumberKeyboard;

package/lib/components/virtual-keyboard/Keyboard/index.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+import './index.less';
+export declare type ItemValue = string | number;
+export interface Item {
+    value: ItemValue;
+    label: React.ReactNode;
+    disabled: boolean;
+    type: 'text' | 'primary';
+    style?: React.CSSProperties;
+    size?: number;
+}
+export interface KeyboardProps {
+    className?: string;
+    style?: React.CSSProperties;
+    onChange?: (value?: ItemValue) => void;
+    items?: Item[];
+    rightItems?: Item[];
+    keydown?: boolean;
+}
+declare const _default: React.MemoExoticComponent<(props: KeyboardProps) => JSX.Element>;
+export default _default;

package/lib/components/virtual-keyboard/Number/index.d.ts

@@ -0,0 +1,5 @@
+import { NumberProps } from './types';
+import './index.less';
+export type { NumberProps };
+declare const Number: (props: NumberProps) => JSX.Element;
+export default Number;