@cloudtower/eagle 0.34.25 → 0.35.2

package/dist/src/core/LocalUpload/LocalUpload.d.ts

@@ -0,0 +1,15 @@
+import React from "react";
+import { UploadWrapper } from "./LocalUpload.style";
+import type { LocalUploadProps } from "./LocalUpload.type";
+import { UploadButton, UploadDescription, UploadDragger, UploadFileInfo, UploadFileList, UploadLabel } from "./LocalUpload.widget";
+type UploadComponents = {
+    Wrapper: typeof UploadWrapper;
+    Label: typeof UploadLabel;
+    Description: typeof UploadDescription;
+    Button: typeof UploadButton;
+    Dragger: typeof UploadDragger;
+    FileList: typeof UploadFileList;
+    FileInfo: typeof UploadFileInfo;
+};
+export declare const LocalUpload: React.ForwardRefExoticComponent<LocalUploadProps & React.RefAttributes<HTMLDivElement>> & UploadComponents;
+export {};

package/dist/src/core/LocalUpload/LocalUpload.hooks.d.ts

@@ -0,0 +1,32 @@
+import type { LocalUploadButtonProps, LocalUploadDraggerProps, LocalUploadFile } from "./LocalUpload.type";
+/**
+ * Custom hook to handle file validation automatically.
+ * When files with status "need-validate" are detected, it validates them
+ * and updates their status based on the validation result.
+ *
+ * @param options - Configuration options
+ * @param options.fileList - Current file list
+ * @param options.setFileList - Function to update file list
+ * @param options.validate - Validation function
+ * @param options.createNewFile - Whether to create a new File object when updating (for immutability)
+ */
+export declare const useFileValidation: ({ fileList, setFileList, validate, createNewFile, }: {
+    fileList: LocalUploadFile[];
+    setFileList: (files: LocalUploadFile[]) => void;
+    validate?: LocalUploadDraggerProps["validate"] | LocalUploadButtonProps["validate"];
+    createNewFile?: boolean | undefined;
+}) => void;
+/**
+ * Custom hook to clear error message when file count changes and is within the max count limit.
+ * This hook tracks file count changes using a ref to avoid unnecessary updates.
+ *
+ * @param options - Configuration options
+ * @param options.fileList - Current file list
+ * @param options.maxCount - Maximum allowed file count
+ * @param options.setError - Function to set error message
+ */
+export declare const useFileCountErrorClear: ({ fileList, maxCount, setError, }: {
+    fileList: LocalUploadFile[];
+    maxCount: number;
+    setError: (error: string) => void;
+}) => void;

package/dist/src/core/LocalUpload/LocalUpload.style.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+export declare const UploadWrapper: import("@linaria/react").StyledComponent<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & Record<never, unknown>>;
+export declare const FileInfoWrapperStyle: import("@linaria/core").LinariaClassName;

package/dist/src/core/LocalUpload/LocalUpload.type.d.ts

@@ -0,0 +1,175 @@
+/// <reference types="react" />
+import { AntdRcFile, AntdUploadProps } from "../../antd";
+/**
+ * 上传文件对象
+ * 继承自 Antd 的 RcFile，并添加额外的状态和错误信息
+ */
+export interface LocalUploadFile extends AntdRcFile {
+    /** 文件唯一标识 */
+    uid: string;
+    /** 文件大小（字节） */
+    size: number;
+    /** 文件名 */
+    name: string;
+    /** 文件类型 */
+    type: string;
+    /** 备用文件名 */
+    fileName?: string | undefined;
+    /** 文件状态 */
+    fileStatus: "error" | "success" | "need-validate" | "validating";
+    /** 自定义数据 */
+    data?: any;
+    /** 错误信息 */
+    error?: string | null;
+}
+/**
+ * 文件接受类型
+ * 限制只能是以 . 开头的文件扩展名
+ */
+export type LocalUploadAccept = `.${string}`;
+/**
+ * 上传按钮属性
+ */
+export type LocalUploadButtonProps = Pick<AntdUploadProps, "accept" | "multiple" | "disabled"> & {
+    /** 自定义类名 */
+    className?: string;
+    /** 是否隐藏图标 */
+    hideIcon?: boolean;
+    /** 文件列表 */
+    fileList: LocalUploadFile[];
+    /** 设置文件列表 */
+    setFileList: (files: LocalUploadFile[]) => void;
+    /** 最大文件数量 */
+    maxCount?: number;
+    /**
+     * 文件验证函数
+     * @param file 当前文件
+     * @param files 文件列表
+     * @returns 返回包含错误信息或自定义数据的 Promise
+     */
+    validate?: (file: LocalUploadFile, files?: LocalUploadFile[]) => Promise<{
+        error?: string;
+        data?: any;
+    }>;
+};
+/**
+ * 拖拽上传属性
+ */
+export type LocalUploadDraggerProps = Pick<AntdUploadProps, "accept" | "multiple" | "disabled"> & {
+    /** 自定义类名 */
+    className?: string;
+    /** 文件列表 */
+    fileList: LocalUploadFile[];
+    /** 设置文件列表 */
+    setFileList: (files: LocalUploadFile[]) => void;
+    /** 最大文件数量 */
+    maxCount?: number;
+    /**
+     * 文件验证函数
+     * @param file 当前文件
+     * @param files 文件列表
+     * @returns 返回包含错误信息或自定义数据的 Promise
+     */
+    validate?: (file: LocalUploadFile, files?: LocalUploadFile[]) => Promise<{
+        error?: string;
+        data?: any;
+    }>;
+};
+/**
+ * 文件列表属性
+ */
+export type LocalUploadFileListProps = {
+    /** 自定义类名 */
+    className?: string;
+    /** 文件列表 */
+    fileList: LocalUploadFile[];
+    /** 列表展示类型 */
+    type?: "list" | "info";
+    /** 移除文件回调 */
+    removeFile: (id: string) => void;
+    /** 是否禁用移除操作 */
+    disableRemove?: boolean;
+    /** 文件移除事件回调 */
+    onRemove?: (file: LocalUploadFile) => void;
+};
+/**
+ * 文件信息展示属性
+ */
+export type LocalUploadFileInfoProps = {
+    /** 文件对象 */
+    file: {
+        /** 文件状态 */
+        fileStatus?: "error" | "success" | "need-validate" | "validating";
+        /** 文件名 */
+        name: string;
+        /** 备用文件名 */
+        fileName?: string;
+        /** 文件大小 */
+        size?: number;
+        /** 文件唯一标识 */
+        uid?: string;
+        /** 错误信息 */
+        error?: string | null;
+    };
+    /** 移除文件回调 */
+    removeFile: (id: string) => void;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 文件移除事件回调 */
+    onRemove?: (file: LocalUploadFile) => void;
+};
+/**
+ * Upload 组件属性
+ */
+export type LocalUploadProps = {
+    /** 自定义类名 */
+    className?: string;
+    /** 标签 */
+    label?: React.ReactNode;
+    /** 描述文本 */
+    description?: React.ReactNode;
+    /** 额外信息 */
+    info?: React.ReactNode;
+    /** 上传类型：按钮或拖拽 */
+    type?: "button" | "dragger";
+    /** 列表展示类型 */
+    listType?: "list" | "info";
+    /** 是否支持多选 */
+    multiple?: boolean;
+    /** 接受的文件类型 */
+    accept?: LocalUploadAccept;
+    /** 是否禁用 */
+    disabled?: boolean;
+    /** 最大文件数量 */
+    maxCount?: number;
+    /** 文件列表 */
+    fileList: LocalUploadFile[];
+    /** 设置文件列表 */
+    setFileList: (files: LocalUploadFile[]) => void;
+    /** 是否禁用文件列表的移除功能 */
+    disableRemoveList?: boolean;
+    /**
+     * 文件验证函数
+     * @param file 当前文件
+     * @param files 文件列表
+     * @returns 返回包含错误信息或自定义数据的 Promise
+     *
+     * @example
+     * ```ts
+     * const validate = async (file: LocalUploadFile) => {
+     *   if (file.size > 5 * 1024 * 1024) {
+     *     return { error: "文件大小不能超过 5MB" };
+     *   }
+     *   return { data: { validated: true } };
+     * };
+     * ```
+     */
+    validate?: (file: LocalUploadFile, files?: LocalUploadFile[]) => Promise<{
+        error?: string;
+        data?: any;
+    }>;
+    /** 按钮属性 */
+    buttonProps?: Pick<LocalUploadButtonProps, "className" | "hideIcon">;
+    /** 文件移除事件回调 */
+    onRemove?: (file: LocalUploadFile) => void;
+};

package/dist/src/core/LocalUpload/LocalUpload.widget.d.ts

@@ -0,0 +1,23 @@
+import React from "react";
+import type { LocalUploadButtonProps, LocalUploadDraggerProps, LocalUploadFile, LocalUploadFileInfoProps, LocalUploadFileListProps } from "./LocalUpload.type";
+export declare const UploadLabel: React.FC<{
+    className?: string;
+    children?: React.ReactNode;
+}>;
+export declare const UploadDescription: React.FC<{
+    className?: string;
+    children?: React.ReactNode;
+}>;
+export declare const UploadButton: React.FC<LocalUploadButtonProps & {
+    children?: React.ReactNode;
+}>;
+export declare const UploadDragger: React.FC<LocalUploadDraggerProps & {
+    children?: React.ReactNode;
+}>;
+export declare const UploadFileInfo: React.FC<LocalUploadFileInfoProps>;
+export declare const FileListItem: React.FC<{
+    file: LocalUploadFile;
+    removeFile: (id: string) => void;
+    onRemove?: (file: LocalUploadFile) => void;
+}>;
+export declare const UploadFileList: React.FC<LocalUploadFileListProps>;

package/dist/src/core/LocalUpload/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./LocalUpload";
+export * from "./LocalUpload.type";

package/dist/src/core/index.d.ts

@@ -50,6 +50,7 @@ export * from "./Legend";
 export * from "./LineChart";
 export * from "./Link";
 export * from "./Loading";
+export * from "./LocalUpload";
 export * from "./MediumDialog";
 export * from "./message";
 export * from "./message-group";

package/dist/stories/docs/core/LocalUpload.stories.d.ts

@@ -0,0 +1,74 @@
+import { LocalUpload } from "../../../src/core/LocalUpload";
+import { Meta, StoryObj } from "@storybook/react";
+/**
+ * LocalUpload 组件用于本地文件上传，支持按钮上传和拖拽上传两种方式。
+ *
+ * ## 功能特点
+ * - 支持单文件和多文件上传
+ * - 支持拖拽上传
+ * - 支持文件验证
+ * - 支持上传进度展示
+ * - 支持错误提示
+ */
+declare const meta: Meta<typeof LocalUpload>;
+export default meta;
+type Story = StoryObj<typeof LocalUpload>;
+/**
+ * 基础的拖拽上传示例
+ * 点击或拖拽文件到上传区域即可上传
+ */
+export declare const BasicDragger: Story;
+/**
+ * 单文件拖拽上传
+ * 只允许选择一个文件，选择新文件会替换旧文件
+ */
+export declare const SingleFileDragger: Story;
+/**
+ * 按钮上传示例
+ * 使用按钮触发文件选择对话框
+ */
+export declare const ButtonUpload: Story;
+/**
+ * 限制文件数量
+ * 最多只能上传指定数量的文件
+ */
+export declare const MaxCountUpload: Story;
+/**
+ * 带文件类型限制的上传
+ * 只允许上传指定类型的文件
+ */
+export declare const AcceptTypeUpload: Story;
+/**
+ * 带文件验证的上传
+ * 可以自定义文件验证逻辑，验证失败会显示错误信息
+ */
+export declare const ValidatedUpload: Story;
+/**
+ * 禁用状态
+ * 禁用后无法进行文件上传操作
+ */
+export declare const DisabledUpload: Story;
+/**
+ * 预填充文件
+ */
+export declare const WithPrefilledFiles: Story;
+/**
+ * List 类型文件列表
+ * 使用标准列表展示文件，包含文件名、文件大小、文件状态等信息
+ */
+export declare const ListTypeList: Story;
+/**
+ * Info 类型文件列表
+ * 以 Info 形式展示文件信息，包含文件名、文件大小、文件状态等信息
+ */
+export declare const InfoListType: Story;
+/**
+ * 自定义按钮样式
+ * 可以隐藏图标或添加自定义类名
+ */
+export declare const CustomButtonStyle: Story;
+/**
+ * 文件移除回调
+ * 监听文件移除事件
+ */
+export declare const WithRemoveCallback: Story;