@spacego/fe-components 0.1.0 → 0.2.0

package/lib/types/fe-table/use-edit-table/index.d.ts

@@ -0,0 +1,6 @@
+import { IEditTableHookProps, IUseEditTableRsp } from '../type/table.d';
+/**
+ * 可编辑表格钩子
+ */
+declare const useEditTableHook: <DataType extends Record<string, any> = Record<string, any>>({ tableProps, onTableChange, editTable }: IEditTableHookProps<DataType>) => IUseEditTableRsp<DataType>;
+export default useEditTableHook;

package/lib/types/fe-table/use-pagination/index.d.ts

@@ -0,0 +1,3 @@
+import { Data, PaginationOptions, PaginationResult, Params, Service } from '../type/table.d';
+declare const usePagination: <TData extends Data, TParams extends Params>(service: Service<TData, TParams>, options?: PaginationOptions<TData, TParams>) => PaginationResult<TData, TParams>;
+export default usePagination;

package/lib/types/fe-table/use-sub-table/index.d.ts

@@ -0,0 +1,8 @@
+import { ITableColumns, ITableParams } from '../type/table.d';
+declare const useSubTable: (params: ITableParams<any>["subTableConfig"] & {
+    btnPermissionList?: string[];
+}) => {
+    subColumns: ITableColumns<any>[];
+    expandableConfig: import('antd/es/table/interface').ExpandableConfig<import('antd/es/_util/type').AnyObject> | undefined;
+};
+export default useSubTable;

package/lib/types/fe-table/use-table/index.d.ts

@@ -0,0 +1,3 @@
+import { ITableParams, IUseTableRsp } from '../type/table.d';
+declare const useTable: <DataType extends Record<string, any> = Record<string, any>>(params: ITableParams<DataType>) => IUseTableRsp;
+export default useTable;

package/lib/types/fe-table/use-table-columns/index.d.ts

@@ -0,0 +1,47 @@
+import { ITableColumns } from '../type/table.d';
+export interface UseTableColumnsProps<T = any> {
+    /**
+     * 原始列配置
+     */
+    columns: ITableColumns<T>[];
+    /**
+     * 是否启用列配置功能
+     */
+    columnSetting?: boolean;
+    /**
+     * 缓存键
+     */
+    tableKey?: string;
+}
+export interface UseTableColumnsReturn<T = any> {
+    /**
+     * 处理后的列配置（包含排序和显示/隐藏）
+     */
+    processedColumns: ITableColumns<T>[];
+    /**
+     * 原始列配置（用于配置组件）
+     */
+    originalColumns: ITableColumns<T>[];
+    /**
+     * 当前隐藏的列
+     */
+    hiddenColumns: string[];
+    /**
+     * 列顺序变化处理
+     */
+    onColumnsChange: (newColumns: ITableColumns<T>[]) => void;
+    /**
+     * 列显示/隐藏变化处理
+     */
+    onColumnVisibilityChange: (dataIndex: string, visible: boolean) => void;
+    /**
+     * 是否启用列配置
+     */
+    columnSettingEnabled: boolean;
+}
+/**
+ * 表格列管理Hook
+ * 处理列的排序、显示/隐藏等功能
+ */
+export declare const useTableColumns: <T extends Record<string, any> = any>(props: UseTableColumnsProps<T>) => UseTableColumnsReturn<T>;
+export default useTableColumns;

package/lib/types/fe-table/use-table-form-context/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 表格表单上下文Hook
+ * 为可编辑表格提供表单上下文处理能力
+ */
+export declare const useTableFormContext: () => {
+    formInstance: import('antd').FormInstance<any>;
+    enhanceRules: (rules: any[], record: any, rowKey: string) => any[];
+    enhanceFormProps: (formProps: any, record: any, rowKey: string) => any;
+};
+export default useTableFormContext;

package/lib/types/fe-table/use-table-selection/index.d.ts

@@ -0,0 +1,46 @@
+import { TableProps } from 'antd';
+import { Key } from 'antd/es/table/interface';
+export interface UseTableSelectionProps<T = any> {
+    /**
+     * 表格行选择配置
+     */
+    rowSelection?: TableProps<T>['rowSelection'];
+    /**
+     * 表格数据源，用于根据selectedRowKeys获取selectedRows
+     */
+    dataSource?: T[];
+    /**
+     * 行唯一标识键名，默认为 'id'
+     */
+    rowKey?: string | ((record: T) => string);
+}
+export interface UseTableSelectionReturn<T = any> {
+    /**
+     * 当前选中的行keys
+     */
+    selectedRowKeys: Key[];
+    /**
+     * 当前选中的行数据
+     */
+    selectedRows: T[];
+    /**
+     * 处理后的rowSelection配置，传递给Table组件
+     */
+    rowSelection: TableProps<T>['rowSelection'] | undefined;
+    /**
+     * 清空选择
+     */
+    onCleanSelected: () => void;
+    /**
+     * 是否为受控模式
+     */
+    isControlled: boolean;
+}
+/**
+ * 表格行选择逻辑Hook
+ * 支持受控和非受控模式
+ * - 受控模式：外部传入selectedRowKeys，组件不维护内部状态
+ * - 非受控模式：内部维护selectedRowKeys状态
+ */
+export declare const useTableSelection: <T extends Record<string, any> = any>(props: UseTableSelectionProps<T>) => UseTableSelectionReturn<T>;
+export default useTableSelection;

package/lib/types/fe-text-area/index.d.ts

@@ -0,0 +1,4 @@
+import { Input } from 'antd';
+type TextAreaProps = Parameters<typeof Input.TextArea>[0];
+
+export interface FeTextAreaProps extends TextAreaProps {}

package/lib/types/fe-time-picker/index.d.ts

@@ -0,0 +1,3 @@
+import { TimePickerProps } from 'antd';
+export interface FeTimePickerProps extends TimePickerProps {
+}

package/lib/types/fe-upload/index.d.ts

@@ -0,0 +1,85 @@
+import { UploadFile } from 'antd';
+import { UploadChangeParam } from 'antd/es/upload';
+import { FeUploadAtomicProps } from '../fe-upload-atomic/index.d';
+import { AcceptType } from './upload.constant';
+export type TCropConfig = {
+  width?: number;
+  height?: number;
+  roate?: boolean;
+};
+
+export interface IFeUploadProps extends Omit<FeUploadAtomicProps, 'accept' | 'onChange' | 'customRequest'> {
+  /**
+   * @name 自定义样式类型
+   * @params render 手动画children样式
+   * @params default 方形+加号上传框 - 默认样式
+   * @params card 卡片样式，可拖动上传，身份证场景
+   * @params btn 单个按钮样式，文件列表场景
+   */
+  customType?: 'render' | 'default' | 'card' | 'btn' | 'drag';
+  /**
+   * @name 拖拽框/上传按钮内文案
+   */
+  title?: string | string[];
+  /**
+   * @name 上传的fileList
+   *
+   * 当maxCount === 1时，value可为string类型
+   */
+  value?: string | UploadFile[];
+  /**
+   * @name 底部提示
+   */
+  tips?: string;
+  /**
+   * @name 可上传文件大小，单位：B，默认20M（1024*1024*20）
+   */
+  fileSize?: number;
+  /**
+   * @name 上传图片是否支持裁剪
+   * @param isOpen 打开、关闭
+   */
+  isCropImage?: boolean;
+  /**
+   * @name 图片裁剪参数设置
+   */
+  cropCofig?: cropConfig;
+  /**
+   * @name 上传的文件类型限制
+   */
+  accept?: AcceptType | AcceptType[];
+  /**
+   * @name 自定义accept格式，枚举accept不满足需求时使用，customAccept优先级大于accept
+   * @description 可以是预定义的类型（如IMAGE, PDF）或自定义MIME类型字符串（如'image/jpeg,image/png'）
+   */
+  customAccept?: string;
+  /**
+   * @name 上传文件限制类型格式，用于提示
+   * @description 会自动拼接为`上传文件类型只能为${acceptDesc}格式`
+   */
+  acceptDesc?: string;
+  /**
+   * @name 是否手动处理类型校验
+   * @description 默认会根据accept或customAccept自动校验，当isManualValieType为true时，需要手动处理类型校验
+   */
+  isManualValieType?: boolean;
+  /**
+   * @name 是否手动处理预览
+   * @description 默认会根据fileList自动处理预览，当isManualPreview为true时，需要手动处理预览
+   */
+  isManualPreview?: boolean;
+  /**
+   * @name 是否在上传失败时删除文件
+   */
+  isRemoveOnError?: boolean;
+  /**
+   * @name 自定义上传回调
+   */
+  customRequest?: (file: File) => Promise<any>;
+  /**
+   * @name onchange事件
+   * @param fileList fileList列表
+   * @param files antd返回的上传进度和list
+   */
+  onChange?: (fileList: UploadFile[], files: UploadChangeParam<UploadFile>) => void;
+}

package/lib/types/fe-upload/upload.constant.d.ts

@@ -0,0 +1,39 @@
+/** 上传类型常量枚举 */
+export declare const ACCEPT_TYPE: {
+    readonly IMAGE: "IMAGE";
+    readonly PDF: "PDF";
+    readonly WORD: "WORD";
+    readonly EXCEL: "EXCEL";
+    readonly PPT: "PPT";
+    readonly TXT: "TXT";
+    readonly ZIP: "ZIP";
+    readonly VIDEO: "VIDEO";
+    readonly AUDIO: "AUDIO";
+};
+export type AcceptType = keyof typeof ACCEPT_TYPE;
+/** 各类型对应的 accept 字符串和 mime 类型集合 */
+export declare const ACCEPT_TYPE_MAP: Record<AcceptType, {
+    accept: string;
+    mimeSet: Set<string>;
+    label: string;
+}>;
+/**
+ * 校验文件类型是否符合 accept 类型
+ * @param fileType 文件的 mime 类型
+ * @param accept 用户传入的 accept 类型（如 'image', 'pdf', 'word' 等）
+ * @returns boolean
+ */
+export declare function validateFileByAccept(fileType: string, accept?: AcceptType | AcceptType[]): boolean;
+export declare function validateFileByCustomAccept(fileType: string, customAccept?: string): boolean;
+/**
+ * 根据 AcceptType 或 AcceptType[] 获取 accept 字符串
+ * @param acceptType AcceptType 或 AcceptType[]
+ * @returns string
+ */
+export declare function getAccept(acceptType?: AcceptType | AcceptType[]): string;
+/**
+ * 根据 AcceptType 或 AcceptType[] 获取 label/title 字符串
+ * @param acceptType AcceptType 或 AcceptType[]
+ * @returns string
+ */
+export declare function getAcceptLabel(acceptType?: AcceptType | AcceptType[]): string;

package/lib/types/fe-upload-atomic/index.d.ts

@@ -0,0 +1,2 @@
+import { UploadProps } from 'antd';
+export interface FeUploadAtomicProps extends UploadProps {}

package/lib/types/fe-upload-crop/index.d.ts

@@ -0,0 +1,10 @@
+import { RcFile } from 'antd/es/upload';
+import { FunctionComponent } from 'react';
+import { TCropConfig } from '../fe-upload/index.d';
+interface ICropRenderProps {
+    file: RcFile;
+    onCrop?: (croppedImage: Blob) => void;
+    cropConfig?: TCropConfig;
+}
+declare const CropRender: FunctionComponent<ICropRenderProps>;
+export default CropRender;

package/lib/types/hooks/index.d.ts

@@ -1,2 +1,3 @@
 export * from './use-auth.hook';
 export * from './use-nprogress.hook';
+export * from './use-permission.hook';

package/lib/types/hooks/use-descriptions/index.d.ts

@@ -0,0 +1,3 @@
+import { IDescriptionsParams, IUseDescriptions } from './index.d';
+declare const FeUseDescriptions: <DataType extends Record<string, any>>({ descriptionsItems, descriptionsData, bordered, size, rawKeyRef: externalKeyRef, className, styles, ...restProps }: IDescriptionsParams<DataType>) => IUseDescriptions;
+export default FeUseDescriptions;

package/lib/types/hooks/use-form/index.d.ts

@@ -0,0 +1,16 @@
+import { FormInstance } from 'antd';
+import { default as React } from 'react';
+import { FeFormProps } from '../../fe-form/fe-form/index.d';
+
+
+export interface IFormParams<DataType = any>
+  extends FeFormProps<DataType> {
+    setFormData: (data: Partial<DataType> | DataType) => void;
+    key?: string;
+}
+
+export interface IFormProps<DataType> {
+  formProps: FeFormProps<DataType>;
+  formRef: React.RefObject<FormInstance>;
+  validate: (key?: keyof DataType) => Promise<any> | undefined;
+}

package/lib/types/hooks/use-permission.hook/index.d.ts

@@ -0,0 +1,10 @@
+export interface IPermissionStore {
+  /**
+   * @name 按钮权限字符串
+   */
+  btnPermissionList: string[];
+  /**
+   * @name 判断是否有权限
+   */
+  hasPermission: (permission: string | string[]) => boolean;
+}

package/lib/types/index.d.ts

@@ -9,8 +9,40 @@ export * from './router';
 /**------------------------------------------- hooks ------------------------------------------- */
 export * from './hooks';
 /**------------------------------------------- components ------------------------------------------- */
+export { default as FeAutoComplete } from './fe-auto-complete';
+export { default as FeButton } from './fe-button';
+export { default as FeCascader } from './fe-cascader';
+export { default as FeCheckbox } from './fe-checkbox';
+export { default as FeCheckboxGroup } from './fe-checkbox-group';
+export { default as FeDatePicker } from './fe-date-picker';
+export { default as FeDescriptionRender } from './fe-description-render';
+export { default as FeDescriptions } from './fe-descriptions';
+export { default as FeEmpty } from './fe-empty';
+export { default as FeErrorBlock } from './fe-error-block';
+export * from './fe-form';
+export { default as FeInput } from './fe-input';
+export { default as FeInputNumber } from './fe-input-number';
 export * from './fe-layouts';
+export { default as FeLink } from './fe-link';
 export { default as FeLoading } from './fe-loading';
+export { default as FeMap } from './fe-map';
+export { default as FeModal } from './fe-modal';
+export { default as FePagination } from './fe-pagination';
+export { default as FePanel } from './fe-panel';
+export { usePanelContext } from './fe-panel/use-panel-context';
+export { default as FePermission } from './fe-permission';
+export { default as FePermissionProvider } from './fe-permission-provider';
+export { default as FeRadio } from './fe-radio';
+export { default as FeRadioGroup } from './fe-radio-group';
+export { default as FeRichText } from './fe-rich-text';
+export { default as FeSelect } from './fe-select';
+export { default as FeSwitch } from './fe-switch';
+export * from './fe-table';
+export { default as FeTextArea } from './fe-text-area';
+export { default as FeTimePicker } from './fe-time-picker';
+export { default as FeUpload } from './fe-upload';
+export { default as FeUploadAtomic } from './fe-upload-atomic';
+export { default as FeUploadCrop } from './fe-upload-crop';
 /**------------------------------------------- typings ------------------------------------------- */
 export * from './typings/index.d';
 export { type IRecord, type IResponse } from './typings/shims-axios.d';

package/lib/types/typings/index.d.ts

@@ -1,59 +1,98 @@
-/*
- * @Author: dushuai
- * @Date: 2026-01-13 20:55:57
- * @LastEditors: dushuai
- * @LastEditTime: 2026-01-26 23:49:50
- * @description: 类型声明
- */
-/// <reference types="vite-plugin-svgr/client" />
-
-/**
- * 菜单类型枚举
- * @1 目录 - 仅用于菜单分组，不对应实际页面
- * @2 菜单 - 对应实际页面路由
- * @3 按钮 - 页面内的按钮权限
- */
-export type MenuType = 1 | 2 | 3;
-
-/**
- * 路由类型
- */
-export interface IRoute {
-  /** 数据库主键id */
-  id: number
-  /** 菜单类型：1目录、2菜单、3按钮 */
-  menuType: MenuType
-  /** 菜单唯一标识，必填且唯一 */
-  menuId: string
-  /** 路由路径 */
-  path?: string
-  /**
-   * 菜单标识
-   * - 菜单类型：对应 pages 目录下文件夹名称（如 home、system/user）
-   * - 按钮类型：权限标识（如 user:add、user:edit）
-   */
-  menuCode?: string
-  /** 父级菜单的menuId */
-  parentId?: string
-  /** 是否受保护，默认true */
-  protected?: boolean
-  /** 是否是首页（仅菜单类型有效） */
-  index?: boolean
-  /** 路由/菜单标题 */
-  title?: string
-  /** 路由/菜单图标 */
-  icon?: string
-  /** 排序，数字越小越靠前 */
-  sort?: number
-  /** 是否在侧边栏菜单中显示，默认true（详情页等不需要显示在菜单中的页面设为false） */
-  isShowMenu?: boolean
-  /** 是否独立菜单 */
-  isIndependentMenu?: boolean
-  /** 激活路由的menuId */
-  activeRouteMenuId?: string
-}
-
-/**
- * 更新store
- */
-export type TUpdateStore<T> = T | Partial<T> | ((state: T) => T | Partial<T>);
+/*
+ * @Author: dushuai
+ * @Date: 2026-01-13 20:55:57
+ * @LastEditors: dushuai
+ * @LastEditTime: 2026-01-26 23:49:50
+ * @description: 类型声明
+ */
+/// <reference types="vite-plugin-svgr/client" />
+
+/**
+ * 菜单类型枚举
+ * @1 目录 - 仅用于菜单分组，不对应实际页面
+ * @2 菜单 - 对应实际页面路由
+ * @3 按钮 - 页面内的按钮权限
+ */
+export type MenuType = 1 | 2 | 3;
+
+/**
+ * 路由类型
+ */
+export interface IRoute {
+  /** 数据库主键id */
+  id: number
+  /** 菜单类型：1目录、2菜单、3按钮 */
+  menuType: MenuType
+  /** 菜单唯一标识，必填且唯一 */
+  menuId: string
+  /** 路由路径 */
+  path?: string
+  /**
+   * 菜单标识
+   * - 菜单类型：对应 pages 目录下文件夹名称（如 home、system/user）
+   * - 按钮类型：权限标识（如 user:add、user:edit）
+   */
+  menuCode?: string
+  /** 父级菜单的menuId */
+  parentId?: string
+  /** 是否受保护，默认true */
+  protected?: boolean
+  /** 是否是首页（仅菜单类型有效） */
+  index?: boolean
+  /** 路由/菜单标题 */
+  title?: string
+  /** 路由/菜单图标 */
+  icon?: string
+  /** 排序，数字越小越靠前 */
+  sort?: number
+  /** 是否在侧边栏菜单中显示，默认true（详情页等不需要显示在菜单中的页面设为false） */
+  isShowMenu?: boolean
+  /** 是否独立菜单 */
+  isIndependentMenu?: boolean
+  /** 激活路由的menuId */
+  activeRouteMenuId?: string
+}
+
+/**
+ * 更新store
+ */
+export type TUpdateStore<T> = T | Partial<T> | ((state: T) => T | Partial<T>);
+
+declare global {
+  interface Number {
+    toFixedNew: (len: number) => string;
+    countDecimals: () => number;
+  }
+}
+
+/**
+ * @name 基础属性
+ */
+export interface IBasicProps {
+  /**
+   * @name 样式
+   */
+  style?: React.CSSProperties;
+  /**
+   * @name 类名
+   */
+  className?: string;
+  /**
+   * @name children
+   */
+  children?: React.ReactNode | string;
+}
+
+/**
+ * @name 权限属性
+ */
+export interface IPermissionProps {
+  /**
+   * @name 按钮权限字符串
+   */
+  btnPermission?: string;
+  /**
+   * @name 当无权限时展示的内容，默认为null不展示任何内容
+   */
+  fallback?: React.ReactNode;
+}

package/lib/types/typings/shims-axios.d.ts

@@ -1,38 +1,38 @@
-/*
- * @Author: dushuai
- * @Date: 2025-12-07 16:31:57
- * @LastEditors: dushuai
- * @LastEditTime: 2026-01-13 22:14:53
- * @description: 请求config配置
- */
-declare module 'axios' {
-  export interface AxiosRequestConfig {
-    /**
-     * @name 是否单独处理请求数据，true：返回结构为Response类型(且不处理错误码)，false：返回结构为data类型，默认false
-     */
-    isCheck?: boolean;
-    /**
-     * @name 是否加载loading
-     * @default true
-     */
-    showLoading?: boolean;
-    /**
-     * @name 加载loading的文本，最多七个字
-     */
-    loadingText?: string;
-  }
-}
-
-export interface IResponse<T = unknown> {
-  code: number;
-  data: T;
-  msg: string;
-}
-
-export interface IRecord<T = unknown> {
-  pageNum: number;
-  pageSize: number;
-  records: T[];
-  total: number;
-  totalPage?: number;
-}
+/*
+ * @Author: dushuai
+ * @Date: 2025-12-07 16:31:57
+ * @LastEditors: dushuai
+ * @LastEditTime: 2026-01-13 22:14:53
+ * @description: 请求config配置
+ */
+declare module 'axios' {
+  export interface AxiosRequestConfig {
+    /**
+     * @name 是否单独处理请求数据，true：返回结构为Response类型(且不处理错误码)，false：返回结构为data类型，默认false
+     */
+    isCheck?: boolean;
+    /**
+     * @name 是否加载loading
+     * @default true
+     */
+    showLoading?: boolean;
+    /**
+     * @name 加载loading的文本，最多七个字
+     */
+    loadingText?: string;
+  }
+}
+
+export interface IResponse<T = unknown> {
+  code: number;
+  data: T;
+  msg: string;
+}
+
+export interface IRecord<T = unknown> {
+  pageNum: number;
+  pageSize: number;
+  records: T[];
+  total: number;
+  totalPage?: number;
+}