Référence des options

Toutes les options de configuration pour le hook useDropup.

Options de validation

accept

Types de fichiers à accepter.

// Type MIME unique
useDropup({ accept: 'image/png' });

// Types MIME multiples
useDropup({ accept: 'image/png, image/jpeg, image/gif' });

// Joker
useDropup({ accept: 'image/*' });

// Par extension
useDropup({ accept: '.pdf, .doc, .docx' });

// Format tableau
useDropup({ accept: ['image/*', 'application/pdf', '.txt'] });

Type	Défaut
`string \| string[]`	`undefined` (tous les fichiers)

maxSize

Taille maximale du fichier en octets.

useDropup({ maxSize: 10 * 1024 * 1024 }); // 10 Mo

Type	Défaut
`number`	`undefined` (pas de limite)

minSize

Taille minimale du fichier en octets.

useDropup({ minSize: 1024 }); // 1 Ko minimum

Type	Défaut
`number`	`undefined` (pas de limite)

maxFiles

Nombre maximum de fichiers autorisés.

useDropup({ maxFiles: 5 });

Type	Défaut
`number`	`undefined` (pas de limite)

maxWidth / maxHeight

Dimensions maximales d'image en pixels.

useDropup({
  accept: 'image/*',
  maxWidth: 4096,
  maxHeight: 4096,
});

Type	Défaut
`number`	`undefined` (pas de limite)

minWidth / minHeight

Dimensions minimales d'image en pixels.

useDropup({
  accept: 'image/*',
  minWidth: 100,
  minHeight: 100,
});

Type	Défaut
`number`	`undefined` (pas de limite)

customRules

Fonctions de validation personnalisées.

useDropup({
  customRules: [
    // Validation synchrone
    (file) => {
      if (file.name.includes('draft')) {
        return 'Fichiers brouillons non autorisés';
      }
      return true;
    },
    // Validation asynchrone
    async (file) => {
      const exists = await checkServerDuplicate(file);
      return exists ? 'Le fichier existe déjà' : true;
    },
  ],
});

Type	Défaut
`ValidationRule[]`	`[]`

Type ValidationRule :

type ValidationRule = (file: File) => boolean | string | Promise<boolean | string>;

Options de comportement

multiple

Autoriser la sélection multiple de fichiers.

useDropup({ multiple: true });  // Fichiers multiples
useDropup({ multiple: false }); // Un seul fichier

Type	Défaut
`boolean`	`true`

disabled

Désactiver la zone de dépôt.

useDropup({ disabled: true });

Type	Défaut
`boolean`	`false`

autoUpload

Démarrer automatiquement le téléversement lorsque des fichiers sont ajoutés.

useDropup({
  upload: { url: '/api/upload' },
  autoUpload: true,
});

Type	Défaut
`boolean`	`false`

generatePreviews

Générer des URLs d'aperçu pour les fichiers image.

useDropup({ generatePreviews: true });

// Accéder à l'aperçu
files[0].preview // "blob:http://..."

Type	Défaut
`boolean`	`true`

Configuration de téléversement

upload

Configurer la destination et le comportement du téléversement.

Configuration basée sur l'URL

useDropup({
  upload: {
    url: '/api/upload',
    method: 'POST',
    headers: {
      'Authorization': 'Bearer token',
    },
    fieldName: 'file',
    withCredentials: true,
    timeout: 30000,
  },
});

Propriétés UploadConfig :

Propriété	Type	Défaut	Description
`url`	`string`	Requis	URL du point de terminaison de téléversement
`method`	`string`	`'POST'`	Méthode HTTP
`headers`	`Record<string, string>`	`{}`	En-têtes de requête
`fieldName`	`string`	`'file'`	Nom du champ de formulaire pour le fichier
`withCredentials`	`boolean`	`false`	Inclure les cookies
`timeout`	`number`	`0`	Délai d'expiration de la requête (ms)
`data`	`Record<string, unknown>`	`{}`	Données de formulaire supplémentaires

Téléverseur personnalisé

useDropup({
  upload: async (file, options) => {
    const formData = new FormData();
    formData.append('file', file.file);

    const response = await fetch('/api/upload', {
      method: 'POST',
      body: formData,
      signal: options.signal,
    });

    const data = await response.json();
    return { url: data.url };
  },
});

Type CustomUploader :

type CustomUploader = (
  file: DropupFile,
  options: UploadOptions
) => Promise<UploadResult>;

interface UploadOptions {
  signal: AbortSignal;
  onProgress: (progress: number) => void;
}

interface UploadResult {
  url?: string;
  response?: unknown;
}

Téléverseurs Cloud

import { createS3Uploader } from '@samithahansaka/dropup/cloud/s3';

useDropup({
  upload: createS3Uploader({
    getPresignedUrl: async (file) => {
      const res = await fetch('/api/s3-presign', {
        method: 'POST',
        body: JSON.stringify({ filename: file.name, type: file.type }),
      });
      return res.json();
    },
  }),
});

Options de callback

onFilesAdded

Appelé lorsque des fichiers sont ajoutés (après validation).

useDropup({
  onFilesAdded: (files) => {
    console.log('Ajoutés:', files.map(f => f.name));
  },
});

Type
`(files: DropupFile[]) => void`

onFileRemoved

Appelé lorsqu'un fichier est supprimé.

useDropup({
  onFileRemoved: (file) => {
    console.log('Supprimé:', file.name);
  },
});

Type
`(file: DropupFile) => void`

onValidationError

Appelé lorsque des fichiers échouent à la validation.

useDropup({
  accept: 'image/*',
  onValidationError: (errors) => {
    errors.forEach(({ file, errors }) => {
      console.log(`${file.name}: ${errors.join(', ')}`);
    });
  },
});

Type
`(errors: ValidationError[]) => void`

onUploadStart

Appelé lorsqu'un fichier commence à être téléversé.

useDropup({
  onUploadStart: (file) => {
    console.log('Début du téléversement:', file.name);
  },
});

Type
`(file: DropupFile) => void`

onUploadProgress

Appelé pendant la progression du téléversement.

useDropup({
  onUploadProgress: (file, progress) => {
    console.log(`${file.name}: ${progress}%`);
  },
});

Type
`(file: DropupFile, progress: number) => void`

onUploadComplete

Appelé lorsqu'un téléversement de fichier est terminé.

useDropup({
  onUploadComplete: (file, response) => {
    console.log('Téléversé:', file.uploadedUrl);
    console.log('Réponse du serveur:', response);
  },
});

Type
`(file: DropupFile, response: unknown) => void`

onUploadError

Appelé lorsqu'un téléversement de fichier échoue.

useDropup({
  onUploadError: (file, error) => {
    console.error(`Échec: ${file.name}`, error.message);
  },
});

Type
`(file: DropupFile, error: DropupError) => void`

onAllComplete

Appelé lorsque tous les fichiers ont terminé d'être téléversés.

useDropup({
  onAllComplete: (files) => {
    const successful = files.filter(f => f.status === 'complete');
    console.log(`${successful.length}/${files.length} téléversés avec succès`);
  },
});

Type
`(files: DropupFile[]) => void`

Exemple complet

const { files, actions, state, getDropProps, getInputProps } = useDropup({
  // Validation
  accept: ['image/*', 'application/pdf'],
  maxSize: 10 * 1024 * 1024,
  maxFiles: 5,

  // Comportement
  multiple: true,
  autoUpload: false,
  generatePreviews: true,

  // Téléversement
  upload: {
    url: '/api/upload',
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
    },
  },

  // Callbacks
  onFilesAdded: (files) => {
    toast.info(`${files.length} fichier(s) ajouté(s)`);
  },
  onValidationError: (errors) => {
    toast.error(`${errors.length} fichier(s) rejeté(s)`);
  },
  onUploadProgress: (file, progress) => {
    console.log(`${file.name}: ${progress}%`);
  },
  onUploadComplete: (file) => {
    toast.success(`${file.name} téléversé !`);
  },
  onUploadError: (file, error) => {
    toast.error(`${file.name} échoué: ${error.message}`);
  },
  onAllComplete: (files) => {
    const count = files.filter(f => f.status === 'complete').length;
    toast.success(`Tout est terminé ! ${count} fichiers téléversés.`);
  },
});

Options de validation​

accept​

maxSize​

minSize​

maxFiles​

maxWidth / maxHeight​

minWidth / minHeight​

customRules​

Options de comportement​

multiple​

disabled​

autoUpload​

generatePreviews​

Configuration de téléversement​

upload​

Configuration basée sur l'URL​

Téléverseur personnalisé​

Téléverseurs Cloud​

Options de callback​

onFilesAdded​

onFileRemoved​

onValidationError​

onUploadStart​

onUploadProgress​

onUploadComplete​

onUploadError​

onAllComplete​

Exemple complet​