Справочник по опциям

Все параметры конфигурации для хука useDropup.

Опции валидации

accept

Принимаемые типы файлов.

// Один MIME тип
useDropup({ accept: 'image/png' });

// Несколько MIME типов
useDropup({ accept: 'image/png, image/jpeg, image/gif' });

// Подстановочный знак
useDropup({ accept: 'image/*' });

// По расширению
useDropup({ accept: '.pdf, .doc, .docx' });

// Формат массива
useDropup({ accept: ['image/*', 'application/pdf', '.txt'] });

Тип	По умолчанию
`string \| string[]`	`undefined` (все файлы)

maxSize

Максимальный размер файла в байтах.

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

Тип	По умолчанию
`number`	`undefined` (без ограничения)

minSize

Минимальный размер файла в байтах.

useDropup({ minSize: 1024 }); // минимум 1КБ

Тип	По умолчанию
`number`	`undefined` (без ограничения)

maxFiles

Максимальное количество разрешенных файлов.

useDropup({ maxFiles: 5 });

Тип	По умолчанию
`number`	`undefined` (без ограничения)

maxWidth / maxHeight

Максимальные размеры изображения в пикселях.

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

Тип	По умолчанию
`number`	`undefined` (без ограничения)

minWidth / minHeight

Минимальные размеры изображения в пикселях.

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

Тип	По умолчанию
`number`	`undefined` (без ограничения)

customRules

Пользовательские функции валидации.

useDropup({
  customRules: [
    // Синхронная валидация
    (file) => {
      if (file.name.includes('draft')) {
        return 'Черновики не разрешены';
      }
      return true;
    },
    // Асинхронная валидация
    async (file) => {
      const exists = await checkServerDuplicate(file);
      return exists ? 'Файл уже существует' : true;
    },
  ],
});

Тип	По умолчанию
`ValidationRule[]`	`[]`

Тип ValidationRule:

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

Опции поведения

multiple

Разрешить выбор нескольких файлов.

useDropup({ multiple: true });  // Несколько файлов
useDropup({ multiple: false }); // Только один файл

Тип	По умолчанию
`boolean`	`true`

disabled

Отключить зону сброса.

useDropup({ disabled: true });

Тип	По умолчанию
`boolean`	`false`

autoUpload

Автоматически начинать загрузку при добавлении файлов.

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

Тип	По умолчанию
`boolean`	`false`

generatePreviews

Генерировать URL превью для файлов изображений.

useDropup({ generatePreviews: true });

// Доступ к превью
files[0].preview // "blob:http://..."

Тип	По умолчанию
`boolean`	`true`

Конфигурация загрузки

upload

Настройка назначения и поведения загрузки.

Конфигурация на основе URL

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

Свойства UploadConfig:

Свойство	Тип	По умолчанию	Описание
`url`	`string`	Обязательно	URL конечной точки загрузки
`method`	`string`	`'POST'`	HTTP метод
`headers`	`Record<string, string>`	`{}`	Заголовки запроса
`fieldName`	`string`	`'file'`	Имя поля формы для файла
`withCredentials`	`boolean`	`false`	Включить cookies
`timeout`	`number`	`0`	Таймаут запроса (мс)
`data`	`Record<string, unknown>`	`{}`	Дополнительные данные формы

Пользовательский загрузчик

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

Тип CustomUploader:

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

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

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

Облачные загрузчики

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

Опции колбэков

onFilesAdded

Вызывается при добавлении файлов (после валидации).

useDropup({
  onFilesAdded: (files) => {
    console.log('Добавлено:', files.map(f => f.name));
  },
});

Тип
`(files: DropupFile[]) => void`

onFileRemoved

Вызывается при удалении файла.

useDropup({
  onFileRemoved: (file) => {
    console.log('Удалено:', file.name);
  },
});

Тип
`(file: DropupFile) => void`

onValidationError

Вызывается при провале валидации файлов.

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

Тип
`(errors: ValidationError[]) => void`

onUploadStart

Вызывается при начале загрузки файла.

useDropup({
  onUploadStart: (file) => {
    console.log('Начало загрузки:', file.name);
  },
});

Тип
`(file: DropupFile) => void`

onUploadProgress

Вызывается во время прогресса загрузки.

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

Тип
`(file: DropupFile, progress: number) => void`

onUploadComplete

Вызывается при завершении загрузки файла.

useDropup({
  onUploadComplete: (file, response) => {
    console.log('Загружено:', file.uploadedUrl);
    console.log('Ответ сервера:', response);
  },
});

Тип
`(file: DropupFile, response: unknown) => void`

onUploadError

Вызывается при провале загрузки файла.

useDropup({
  onUploadError: (file, error) => {
    console.error(`Провалено: ${file.name}`, error.message);
  },
});

Тип
`(file: DropupFile, error: DropupError) => void`

onAllComplete

Вызывается при завершении загрузки всех файлов.

useDropup({
  onAllComplete: (files) => {
    const successful = files.filter(f => f.status === 'complete');
    console.log(`${successful.length}/${files.length} успешно загружено`);
  },
});

Тип
`(files: DropupFile[]) => void`

Полный пример

const { files, actions, state, getDropProps, getInputProps } = useDropup({
  // Валидация
  accept: ['image/*', 'application/pdf'],
  maxSize: 10 * 1024 * 1024,
  maxFiles: 5,

  // Поведение
  multiple: true,
  autoUpload: false,
  generatePreviews: true,

  // Загрузка
  upload: {
    url: '/api/upload',
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
    },
  },

  // Колбэки
  onFilesAdded: (files) => {
    toast.info(`${files.length} файл(ов) добавлено`);
  },
  onValidationError: (errors) => {
    toast.error(`${errors.length} файл(ов) отклонено`);
  },
  onUploadProgress: (file, progress) => {
    console.log(`${file.name}: ${progress}%`);
  },
  onUploadComplete: (file) => {
    toast.success(`${file.name} загружен!`);
  },
  onUploadError: (file, error) => {
    toast.error(`${file.name} провалено: ${error.message}`);
  },
  onAllComplete: (files) => {
    const count = files.filter(f => f.status === 'complete').length;
    toast.success(`Всё готово! ${count} файлов загружено.`);
  },
});

Опции валидации​

accept​

maxSize​

minSize​

maxFiles​

maxWidth / maxHeight​

minWidth / minHeight​

customRules​

Опции поведения​

multiple​

disabled​

autoUpload​

generatePreviews​

Конфигурация загрузки​

upload​

Конфигурация на основе URL​

Пользовательский загрузчик​

Облачные загрузчики​

Опции колбэков​

onFilesAdded​

onFileRemoved​

onValidationError​

onUploadStart​

onUploadProgress​

onUploadComplete​

onUploadError​

onAllComplete​

Полный пример​