florixui 1.0.0 → 1.1.0

package/dist/lib/use-file-upload.d.ts

@@ -0,0 +1,58 @@
+import { ChangeEvent, DragEvent, InputHTMLAttributes } from 'react';
+/** A file that already lives on a server (e.g. previously uploaded). */
+export type FileMetadata = {
+    name: string;
+    size: number;
+    type: string;
+    url: string;
+    id: string;
+};
+/** An entry in the uploader: either a freshly picked `File` or remote metadata. */
+export type FileWithPreview = {
+    file: File | FileMetadata;
+    id: string;
+    preview?: string;
+};
+export type FileUploadOptions = {
+    /** Maximum number of files allowed (multiple mode). Defaults to unlimited. */
+    maxFiles?: number;
+    /** Maximum size per file, in bytes. Defaults to unlimited. */
+    maxSize?: number;
+    /** `accept` attribute, e.g. `"image/*"` or `".pdf,.docx"`. Defaults to `"*"`. */
+    accept?: string;
+    /** Allow selecting more than one file. */
+    multiple?: boolean;
+    /** Files to seed the uploader with (already-uploaded items). */
+    initialFiles?: FileMetadata[];
+    /** Called whenever the file list changes. */
+    onFilesChange?: (files: FileWithPreview[]) => void;
+    /** Called with only the files added in the latest action. */
+    onFilesAdded?: (addedFiles: FileWithPreview[]) => void;
+};
+export type FileUploadState = {
+    files: FileWithPreview[];
+    isDragging: boolean;
+    errors: string[];
+};
+export type FileUploadActions = {
+    addFiles: (files: FileList | File[]) => void;
+    removeFile: (id: string) => void;
+    clearFiles: () => void;
+    clearErrors: () => void;
+    handleDragEnter: (e: DragEvent<HTMLElement>) => void;
+    handleDragLeave: (e: DragEvent<HTMLElement>) => void;
+    handleDragOver: (e: DragEvent<HTMLElement>) => void;
+    handleDrop: (e: DragEvent<HTMLElement>) => void;
+    handleFileChange: (e: ChangeEvent<HTMLInputElement>) => void;
+    openFileDialog: () => void;
+    getInputProps: (props?: InputHTMLAttributes<HTMLInputElement>) => InputHTMLAttributes<HTMLInputElement> & {
+        ref: React.Ref<HTMLInputElement>;
+    };
+};
+/** Human-readable byte size, e.g. `1.46MB`. */
+export declare const formatBytes: (bytes: number, decimals?: number) => string;
+/**
+ * Headless file-upload state machine: validation, drag & drop, previews, and
+ * input wiring. Pair it with your own markup (see `FileUpload` for a default UI).
+ */
+export declare const useFileUpload: (options?: FileUploadOptions) => [FileUploadState, FileUploadActions];