メインコンテンツまでスキップ

移行ガイド

他の人気アップロードライブラリからDropupへの移行方法。

react-dropzoneから​

react-dropzoneは人気のドラッグ&ドロップライブラリです。Dropupはビルトインのアップロードサポート付きで同様の機能を提供します。

移行前（react-dropzone）​

import { useDropzone } from 'react-dropzone';

function OldUploader() {
  const [files, setFiles] = useState([]);

  const { getRootProps, getInputProps, isDragActive } = useDropzone({
    accept: { 'image/*': [] },
    maxSize: 10485760,
    onDrop: (acceptedFiles) => {
      setFiles(acceptedFiles.map(file => ({
        ...file,
        preview: URL.createObjectURL(file),
      })));
    },
  });

  const handleUpload = async () => {
    for (const file of files) {
      const formData = new FormData();
      formData.append('file', file);
      await fetch('/api/upload', {
        method: 'POST',
        body: formData,
      });
    }
  };

  return (
    <div {...getRootProps()}>
      <input {...getInputProps()} />
      {isDragActive ? <p>ここにドロップ</p> : <p>ここにファイルをドラッグ</p>}
    </div>
  );
}

移行後（Dropup）​

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

function NewUploader() {
  const { files, actions, state, getDropProps, getInputProps } = useDropup({
    accept: 'image/*',
    maxSize: 10 * 1024 * 1024,
    upload: { url: '/api/upload' },  // ビルトインアップロード！
  });

  return (
    <div {...getDropProps()}>
      <input {...getInputProps()} />
      {state.isDragging ? <p>ここにドロップ</p> : <p>ここにファイルをドラッグ</p>}

      {files.map(file => (
        <div key={file.id}>
          {file.preview && <img src={file.preview} />}
          <span>{file.progress}%</span>
        </div>
      ))}

      <button onClick={() => actions.upload()}>アップロード</button>
    </div>
  );
}

主な違い​

react-dropzoneDropup
getRootProps()getDropProps()
isDragActivestate.isDragging
accept: { 'image/*': [] }accept: 'image/*'
アップロード機能なし進捗付きビルトインアップロード
手動プレビュークリーンアップ自動クリーンアップ

react-uploadyから​

react-uploadyは複数のコンポーネントを持つ機能豊富なアップロードライブラリです。

移行前（react-uploady）​

import Uploady, { useItemProgressListener, useUploady } from '@rpldy/uploady';
import UploadDropZone from '@rpldy/upload-drop-zone';

function OldApp() {
  return (
    <Uploady destination={{ url: '/api/upload' }}>
      <UploadDropZone onDragOverClassName="drag-over">
        <div>ここにファイルをドロップ</div>
      </UploadDropZone>
      <UploadProgress />
    </Uploady>
  );
}

function UploadProgress() {
  useItemProgressListener((item) => {
    console.log(`${item.file.name}: ${item.completed}%`);
  });

  const { processPending } = useUploady();

  return <button onClick={processPending}>アップロード</button>;
}

移行後（Dropup）​

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

function NewApp() {
  const { files, actions, getDropProps, getInputProps } = useDropup({
    upload: { url: '/api/upload' },
    onUploadProgress: (file, progress) => {
      console.log(`${file.name}: ${progress}%`);
    },
  });

  return (
    <div {...getDropProps()}>
      <input {...getInputProps()} />
      <div>ここにファイルをドロップ</div>

      {files.map(file => (
        <div key={file.id}>
          {file.name}: {file.progress}%
        </div>
      ))}

      <button onClick={() => actions.upload()}>アップロード</button>
    </div>
  );
}

主な違い​

react-uploadyDropup
Provider + コンポーネント単一のフック
useItemProgressListeneronUploadProgressコールバック
processPending()actions.upload()
複数パッケージオールインワン

react-dropzone-uploaderから​

react-dropzone-uploaderはドロップゾーンとアップロード機能を組み合わせています。

移行前（react-dropzone-uploader）​

import Dropzone from 'react-dropzone-uploader';
import 'react-dropzone-uploader/dist/styles.css';

function OldUploader() {
  const getUploadParams = () => ({ url: '/api/upload' });

  const handleChangeStatus = ({ meta, file }, status) => {
    console.log(status, meta, file);
  };

  return (
    <Dropzone
      getUploadParams={getUploadParams}
      onChangeStatus={handleChangeStatus}
      accept="image/*"
      maxSizeBytes={10485760}
    />
  );
}

移行後（Dropup）​

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

function NewUploader() {
  const { files, getDropProps, getInputProps } = useDropup({
    accept: 'image/*',
    maxSize: 10 * 1024 * 1024,
    upload: { url: '/api/upload' },
    autoUpload: true,

    onUploadStart: (file) => console.log('アップロード中', file),
    onUploadComplete: (file) => console.log('完了', file),
    onUploadError: (file, err) => console.log('エラー', file, err),
  });

  return (
    <div {...getDropProps()}>
      <input {...getInputProps()} />
      {/* カスタムUI */}
    </div>
  );
}

主な違い​

react-dropzone-uploaderDropup
ビルトインUI付きコンポーネントヘッドレス（独自UIを持参）
getUploadParamsuploadオプション
onChangeStatus特定のコールバック
CSSインポート必須スタイルなし

Uppyから​

Uppyはフル機能のアップロードツールキットです。

移行前（Uppy）​

import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import XHRUpload from '@uppy/xhr-upload';
import '@uppy/core/dist/style.css';
import '@uppy/dashboard/dist/style.css';

const uppy = new Uppy()
  .use(Dashboard, { inline: true, target: '#uppy' })
  .use(XHRUpload, { endpoint: '/api/upload' });

uppy.on('upload-success', (file, response) => {
  console.log('成功:', file, response);
});

function OldUploader() {
  return <div id="uppy" />;
}

移行後（Dropup）​

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

function NewUploader() {
  const { files, actions, state, getDropProps, getInputProps } = useDropup({
    upload: { url: '/api/upload' },
    onUploadComplete: (file, response) => {
      console.log('成功:', file, response);
    },
  });

  return (
    <div>
      <div {...getDropProps()}>
        <input {...getInputProps()} />
        ここにファイルをドロップ
      </div>

      {files.map(file => (
        <div key={file.id}>
          {file.preview && <img src={file.preview} />}
          <span>{file.name}</span>
          <span>{file.progress}%</span>
        </div>
      ))}

      <button onClick={() => actions.upload()}>アップロード</button>
    </div>
  );
}

主な違い​

UppyDropup
フルUI付きヘッドレス
プラグインシステムオールインワン
大きなバンドル< 10KB
命令型APIReactフック

一般的な移行手順​

1. Dropupをインストール​

npm uninstall react-dropzone react-uploady @rpldy/uploady  # 古いものを削除
npm install @samithahansaka/dropup

2. インポートを更新​

// 移行前
import { useDropzone } from 'react-dropzone';

// 移行後
import { useDropup } from '@samithahansaka/dropup';

3. フックの使用を更新​

// 移行前
const { getRootProps, getInputProps, isDragActive } = useDropzone({...});

// 移行後
const { getDropProps, getInputProps, state } = useDropup({...});
// isDragActiveの代わりにstate.isDraggingを使用

4. アップロード設定を追加​

// Dropupはアップロード機能を含みます
useDropup({
  upload: { url: '/api/upload' },
});

5. イベントハンドラを更新​

// 移行前（react-dropzone）
onDrop: (files) => {...}

// 移行後（Dropup）
onFilesAdded: (files) => {...}
onUploadComplete: (file) => {...}

6. テンプレートを更新​

// 移行前
<div {...getRootProps()}>
  <input {...getInputProps()} />
</div>

// 移行後
<div {...getDropProps()}>
  <input {...getInputProps()} />
</div>

機能比較​

機能react-dropzonereact-uploadyUppyDropup
ドラッグ&ドロップ✓✓✓✓
アップロード✗✓✓✓
進捗✗✓✓✓
チャンク✗✓✓✓
tus✗✓✓✓
クラウド（S3）✗✓✓✓
React Native✗✗✗✓
バンドルサイズ~10KB~30KB~100KB+<10KB
TypeScript✓✓✓✓
ヘッドレス✓部分的✗✓