Referência de Opções

Todas as opções de configuração para o hook useDropup.

Opções de Validação

accept

Tipos de arquivo a aceitar.

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

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

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

// Por extensão
useDropup({ accept: '.pdf, .doc, .docx' });

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

Tipo	Padrão
`string \| string[]`	`undefined` (todos os arquivos)

maxSize

Tamanho máximo do arquivo em bytes.

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

Tipo	Padrão
`number`	`undefined` (sem limite)

minSize

Tamanho mínimo do arquivo em bytes.

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

Tipo	Padrão
`number`	`undefined` (sem limite)

maxFiles

Número máximo de arquivos permitidos.

useDropup({ maxFiles: 5 });

Tipo	Padrão
`number`	`undefined` (sem limite)

maxWidth / maxHeight

Dimensões máximas de imagem em pixels.

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

Tipo	Padrão
`number`	`undefined` (sem limite)

minWidth / minHeight

Dimensões mínimas de imagem em pixels.

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

Tipo	Padrão
`number`	`undefined` (sem limite)

customRules

Funções de validação personalizadas.

useDropup({
  customRules: [
    // Validação síncrona
    (file) => {
      if (file.name.includes('draft')) {
        return 'Arquivos de rascunho não são permitidos';
      }
      return true;
    },
    // Validação assíncrona
    async (file) => {
      const exists = await checkServerDuplicate(file);
      return exists ? 'Arquivo já existe' : true;
    },
  ],
});

Tipo	Padrão
`ValidationRule[]`	`[]`

Tipo ValidationRule:

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

Opções de Comportamento

multiple

Permitir seleção de múltiplos arquivos.

useDropup({ multiple: true });  // Múltiplos arquivos
useDropup({ multiple: false }); // Apenas arquivo único

Tipo	Padrão
`boolean`	`true`

disabled

Desabilitar a dropzone.

useDropup({ disabled: true });

Tipo	Padrão
`boolean`	`false`

autoUpload

Iniciar upload automaticamente quando arquivos são adicionados.

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

Tipo	Padrão
`boolean`	`false`

generatePreviews

Gerar URLs de preview para arquivos de imagem.

useDropup({ generatePreviews: true });

// Acessar preview
files[0].preview // "blob:http://..."

Tipo	Padrão
`boolean`	`true`

Configuração de Upload

upload

Configurar o destino e comportamento do upload.

Configuração baseada em URL

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

Propriedades de UploadConfig:

Propriedade	Tipo	Padrão	Descrição
`url`	`string`	Obrigatório	URL do endpoint de upload
`method`	`string`	`'POST'`	Método HTTP
`headers`	`Record<string, string>`	`{}`	Headers da requisição
`fieldName`	`string`	`'file'`	Nome do campo do formulário para o arquivo
`withCredentials`	`boolean`	`false`	Incluir cookies
`timeout`	`number`	`0`	Timeout da requisição (ms)
`data`	`Record<string, unknown>`	`{}`	Dados adicionais do formulário

Uploader 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;
}

Uploaders de Nuvem

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

Opções de Callback

onFilesAdded

Chamado quando arquivos são adicionados (após validação).

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

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

onFileRemoved

Chamado quando um arquivo é removido.

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

Tipo
`(file: DropupFile) => void`

onValidationError

Chamado quando arquivos falham na validação.

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

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

onUploadStart

Chamado quando um arquivo começa a ser enviado.

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

Tipo
`(file: DropupFile) => void`

onUploadProgress

Chamado durante o progresso do upload.

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

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

onUploadComplete

Chamado quando o upload de um arquivo é concluído.

useDropup({
  onUploadComplete: (file, response) => {
    console.log('Enviado:', file.uploadedUrl);
    console.log('Resposta do servidor:', response);
  },
});

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

onUploadError

Chamado quando o upload de um arquivo falha.

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

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

onAllComplete

Chamado quando todos os arquivos terminam de ser enviados.

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

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

Exemplo Completo

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

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

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

  // Callbacks
  onFilesAdded: (files) => {
    toast.info(`${files.length} arquivo(s) adicionado(s)`);
  },
  onValidationError: (errors) => {
    toast.error(`${errors.length} arquivo(s) rejeitado(s)`);
  },
  onUploadProgress: (file, progress) => {
    console.log(`${file.name}: ${progress}%`);
  },
  onUploadComplete: (file) => {
    toast.success(`${file.name} enviado!`);
  },
  onUploadError: (file, error) => {
    toast.error(`${file.name} falhou: ${error.message}`);
  },
  onAllComplete: (files) => {
    const count = files.filter(f => f.status === 'complete').length;
    toast.success(`Tudo pronto! ${count} arquivos enviados.`);
  },
});

Opções de Validação​

accept​

maxSize​

minSize​

maxFiles​

maxWidth / maxHeight​

minWidth / minHeight​

customRules​

Opções de Comportamento​

multiple​

disabled​

autoUpload​

generatePreviews​

Configuração de Upload​

upload​

Configuração baseada em URL​

Uploader Personalizado​

Uploaders de Nuvem​

Opções de Callback​

onFilesAdded​

onFileRemoved​

onValidationError​

onUploadStart​

onUploadProgress​

onUploadComplete​

onUploadError​

onAllComplete​

Exemplo Completo​