Referencia de opciones

Todas las opciones de configuración para el hook useDropup.

Opciones de validación

accept

Tipos de archivo a aceptar.

// Tipo MIME único
useDropup({ accept: 'image/png' });

// Múltiples tipos MIME
useDropup({ accept: 'image/png, image/jpeg, image/gif' });

// Comodín
useDropup({ accept: 'image/*' });

// Por extensión
useDropup({ accept: '.pdf, .doc, .docx' });

// Formato de array
useDropup({ accept: ['image/*', 'application/pdf', '.txt'] });

Tipo	Por defecto
`string \| string[]`	`undefined` (todos los archivos)

maxSize

Tamaño máximo de archivo en bytes.

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

Tipo	Por defecto
`number`	`undefined` (sin límite)

minSize

Tamaño mínimo de archivo en bytes.

useDropup({ minSize: 1024 }); // 1KB mínimo

Tipo	Por defecto
`number`	`undefined` (sin límite)

maxFiles

Número máximo de archivos permitidos.

useDropup({ maxFiles: 5 });

Tipo	Por defecto
`number`	`undefined` (sin límite)

maxWidth / maxHeight

Dimensiones máximas de imagen en píxeles.

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

Tipo	Por defecto
`number`	`undefined` (sin límite)

minWidth / minHeight

Dimensiones mínimas de imagen en píxeles.

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

Tipo	Por defecto
`number`	`undefined` (sin límite)

customRules

Funciones de validación personalizadas.

useDropup({
  customRules: [
    // Validación síncrona
    (file) => {
      if (file.name.includes('draft')) {
        return 'No se permiten archivos de borrador';
      }
      return true;
    },
    // Validación asíncrona
    async (file) => {
      const exists = await checkServerDuplicate(file);
      return exists ? 'El archivo ya existe' : true;
    },
  ],
});

Tipo	Por defecto
`ValidationRule[]`	`[]`

Tipo ValidationRule:

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

Opciones de comportamiento

multiple

Permitir selección de múltiples archivos.

useDropup({ multiple: true });  // Múltiples archivos
useDropup({ multiple: false }); // Solo un archivo

Tipo	Por defecto
`boolean`	`true`

disabled

Deshabilitar la zona de soltar.

useDropup({ disabled: true });

Tipo	Por defecto
`boolean`	`false`

autoUpload

Iniciar carga automáticamente cuando se agregan archivos.

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

Tipo	Por defecto
`boolean`	`false`

generatePreviews

Generar URLs de vista previa para archivos de imagen.

useDropup({ generatePreviews: true });

// Acceder a vista previa
files[0].preview // "blob:http://..."

Tipo	Por defecto
`boolean`	`true`

Configuración de carga

upload

Configurar el destino y comportamiento de la carga.

Configuración basada en URL

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

Propiedades de UploadConfig:

Propiedad	Tipo	Por defecto	Descripción
`url`	`string`	Requerido	URL del endpoint de carga
`method`	`string`	`'POST'`	Método HTTP
`headers`	`Record<string, string>`	`{}`	Headers de la petición
`fieldName`	`string`	`'file'`	Nombre del campo del formulario para el archivo
`withCredentials`	`boolean`	`false`	Incluir cookies
`timeout`	`number`	`0`	Timeout de la petición (ms)
`data`	`Record<string, unknown>`	`{}`	Datos adicionales del formulario

Cargador personalizado

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 };
  },
});

Tipo CustomUploader:

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

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

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

Cargadores de nube

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();
    },
  }),
});

Opciones de callback

onFilesAdded

Se llama cuando se agregan archivos (después de validación).

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

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

onFileRemoved

Se llama cuando se elimina un archivo.

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

Tipo
`(file: DropupFile) => void`

onValidationError

Se llama cuando los archivos fallan la validación.

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

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

onUploadStart

Se llama cuando un archivo comienza a cargarse.

useDropup({
  onUploadStart: (file) => {
    console.log('Iniciando carga:', file.name);
  },
});

Tipo
`(file: DropupFile) => void`

onUploadProgress

Se llama durante el progreso de carga.

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

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

onUploadComplete

Se llama cuando se completa la carga de un archivo.

useDropup({
  onUploadComplete: (file, response) => {
    console.log('Cargado:', file.uploadedUrl);
    console.log('Respuesta del servidor:', response);
  },
});

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

onUploadError

Se llama cuando falla la carga de un archivo.

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

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

onAllComplete

Se llama cuando todos los archivos terminan de cargarse.

useDropup({
  onAllComplete: (files) => {
    const successful = files.filter(f => f.status === 'complete');
    console.log(`${successful.length}/${files.length} cargados exitosamente`);
  },
});

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

Ejemplo completo

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

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

  // Carga
  upload: {
    url: '/api/upload',
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
    },
  },

  // Callbacks
  onFilesAdded: (files) => {
    toast.info(`${files.length} archivo(s) agregado(s)`);
  },
  onValidationError: (errors) => {
    toast.error(`${errors.length} archivo(s) rechazado(s)`);
  },
  onUploadProgress: (file, progress) => {
    console.log(`${file.name}: ${progress}%`);
  },
  onUploadComplete: (file) => {
    toast.success(`¡${file.name} cargado!`);
  },
  onUploadError: (file, error) => {
    toast.error(`${file.name} falló: ${error.message}`);
  },
  onAllComplete: (files) => {
    const count = files.filter(f => f.status === 'complete').length;
    toast.success(`¡Todo listo! ${count} archivos cargados.`);
  },
});

Opciones de validación​

accept​

maxSize​

minSize​

maxFiles​

maxWidth / maxHeight​

minWidth / minHeight​

customRules​

Opciones de comportamiento​

multiple​

disabled​

autoUpload​

generatePreviews​

Configuración de carga​

upload​

Configuración basada en URL​

Cargador personalizado​

Cargadores de nube​

Opciones de callback​

onFilesAdded​

onFileRemoved​

onValidationError​

onUploadStart​

onUploadProgress​

onUploadComplete​

onUploadError​

onAllComplete​

Ejemplo completo​