ข้ามไปยังเนื้อหาหลัก

useDropup Hook

Hook หลักสำหรับอัปโหลดไฟล์พร้อมรองรับการลากและวาง

การนำเข้า

import { useDropup } from '@samithahansaka/dropup';

การใช้งานพื้นฐาน

const {
files,
state,
actions,
getDropProps,
getInputProps,
openFileDialog,
} = useDropup(options);

พารามิเตอร์

options (ไม่บังคับ)

ดู Options สำหรับรายละเอียดทั้งหมด

interface UseDropupOptions {
// การตรวจสอบ
accept?: string | string[];
maxSize?: number;
minSize?: number;
maxFiles?: number;
maxWidth?: number;
maxHeight?: number;
minWidth?: number;
minHeight?: number;
customRules?: ValidationRule[];

// พฤติกรรม
multiple?: boolean;
disabled?: boolean;
autoUpload?: boolean;
generatePreviews?: boolean;

// การกำหนดค่าการอัปโหลด
upload?: UploadConfig | CustomUploader;

// Callbacks
onFilesAdded?: (files: DropupFile[]) => void;
onFileRemoved?: (file: DropupFile) => void;
onValidationError?: (errors: ValidationError[]) => void;
onUploadStart?: (file: DropupFile) => void;
onUploadProgress?: (file: DropupFile, progress: number) => void;
onUploadComplete?: (file: DropupFile, response: unknown) => void;
onUploadError?: (file: DropupFile, error: DropupError) => void;
onAllComplete?: (files: DropupFile[]) => void;
}

ค่าที่ส่งคืน

ดู Return Values สำหรับรายละเอียดทั้งหมด

interface UseDropupReturn {
// State
files: DropupFile[];
state: DropupState;

// Actions
actions: DropupActions;

// Prop getters
getDropProps: <E extends HTMLElement>(props?: HTMLAttributes<E>) => DropZoneProps<E>;
getInputProps: (props?: InputHTMLAttributes) => InputProps;

// Utilities
openFileDialog: () => void;
}

อ้างอิงด่วน

อาร์เรย์ Files

const { files } = useDropup();

// แต่ละไฟล์มี:
files[0].id // ID เฉพาะ
files[0].file // File object ดั้งเดิม
files[0].name // ชื่อไฟล์
files[0].size // ขนาดเป็นไบต์
files[0].type // MIME type
files[0].preview // URL พรีวิว (รูปภาพ)
files[0].status // 'idle' | 'uploading' | 'complete' | 'error'
files[0].progress // 0-100
files[0].uploadedUrl // URL หลังอัปโหลด
files[0].error // ข้อผิดพลาดถ้าล้มเหลว

State Object

const { state } = useDropup();

state.isDragging // กำลังลากไฟล์อยู่เหนือ
state.isDragAccept // ไฟล์ที่ลากผ่านการตรวจสอบ
state.isDragReject // ไฟล์ที่ลากไม่ผ่านการตรวจสอบ
state.isUploading // กำลังอัปโหลดไฟล์ใดอยู่
state.progress // ความคืบหน้าโดยรวม 0-100
state.status // 'idle' | 'uploading' | 'complete' | 'error'

Actions Object

const { actions } = useDropup();

actions.upload(fileIds?) // เริ่มอัปโหลด
actions.cancel(fileId?) // ยกเลิกการอัปโหลด
actions.remove(fileId) // ลบไฟล์
actions.reset() // ล้างทั้งหมด
actions.retry(fileIds?) // ลองใหม่ที่ล้มเหลว
actions.addFiles(files) // เพิ่มไฟล์แบบ programmatic
actions.updateFileMeta(id, meta) // อัปเดต metadata

Prop Getters

const { getDropProps, getInputProps } = useDropup();

// ใช้กับ drop zone ของคุณ
<div {...getDropProps()}>
<input {...getInputProps()} />
วางที่นี่
</div>

// พร้อม props ที่กำหนดเอง
<div {...getDropProps({ className: 'my-dropzone', onClick: handleClick })}>
...
</div>

ตัวอย่าง

ตัวอย่างขั้นต่ำ

function Uploader() {
const { files, getDropProps, getInputProps } = useDropup();

return (
<div {...getDropProps()}>
<input {...getInputProps()} />
<p>วางไฟล์ที่นี่</p>
<ul>
{files.map(f => <li key={f.id}>{f.name}</li>)}
</ul>
</div>
);
}

พร้อมการอัปโหลด

function Uploader() {
const { files, actions, getDropProps, getInputProps } = useDropup({
upload: {
url: '/api/upload',
method: 'POST',
headers: { 'Authorization': 'Bearer token' },
},
});

return (
<div>
<div {...getDropProps()}>
<input {...getInputProps()} />
<p>วางไฟล์ที่นี่</p>
</div>

{files.map(f => (
<div key={f.id}>
{f.name} - {f.status}
{f.status === 'uploading' && ` ${f.progress}%`}
</div>
))}

<button onClick={() => actions.upload()}>อัปโหลดทั้งหมด</button>
</div>
);
}

พร้อมตัวเลือกทั้งหมด

function FullFeaturedUploader() {
const {
files,
state,
actions,
getDropProps,
getInputProps,
} = useDropup({
// การตรวจสอบ
accept: 'image/*',
maxSize: 10 * 1024 * 1024,
maxFiles: 5,

// พฤติกรรม
multiple: true,
autoUpload: true,
generatePreviews: true,

// การอัปโหลด
upload: {
url: '/api/upload',
method: 'POST',
},

// Callbacks
onFilesAdded: (files) => console.log('เพิ่ม:', files),
onUploadComplete: (file) => console.log('เสร็จ:', file.uploadedUrl),
onUploadError: (file, err) => console.error('ผิดพลาด:', err),
onAllComplete: () => console.log('อัปโหลดทั้งหมดเสร็จสิ้น!'),
});

return (
<div>
<div
{...getDropProps()}
style={{
border: `2px dashed ${state.isDragAccept ? 'green' : state.isDragReject ? 'red' : 'gray'}`,
padding: 40,
}}
>
<input {...getInputProps()} />
<p>วางรูปภาพที่นี่ (สูงสุด 5 ไฟล์, 10MB ต่อไฟล์)</p>
</div>

{files.map(file => (
<div key={file.id}>
{file.preview && <img src={file.preview} width={50} />}
<span>{file.name}</span>
<span>{file.status}</span>
{file.status === 'uploading' && <span>{file.progress}%</span>}
<button onClick={() => actions.remove(file.id)}>×</button>
</div>
))}

{state.isUploading && <p>กำลังอัปโหลด... {state.progress}%</p>}
</div>
);
}