ファイルをドラッグ&ドロップする方法

Thomas Steiner

HTML ドラッグ＆ドロップ インターフェース を使用すると、ウェブページで ドラッグ＆ドロップされたファイル を受け入れることができます。ドラッグ＆ドロップ操作中、ドラッグされたファイルとディレクトリの項目は、それぞれファイル エントリとディレクトリ エントリに関連付けられます。ファイルをブラウザにドラッグ＆ドロップする方法は、最新の方法と従来の方法の 2 つがあります。

最新の方法

File System Access API の DataTransferItem.getAsFileSystemHandle() メソッドを使用する

DataTransferItem.getAsFileSystemHandle() メソッドは、ドラッグされた項目がファイルの場合は FileSystemFileHandle オブジェクトを含む Promise を返し、ドラッグされた項目がディレクトリの場合は FileSystemDirectoryHandle オブジェクトを含む Promise を返します。これらのハンドルを使用すると、ファイルの読み取りや、必要に応じてファイルまたはディレクトリへの書き戻しを行うことができます。ドラッグ＆ドロップ インターフェースの DataTransferItem.kind は、ファイル と ディレクトリの両方で "file" になります。一方、File System Access API の FileSystemHandle.kind は、ファイルの場合は "file"、ディレクトリの場合は "directory" になります。

Browser Support

  • Chrome: 86.
  • Edge: 86.
  • Firefox: not supported.
  • Safari: not supported.

Source

従来の方法

従来の DataTransferItem.getAsFile() メソッドを使用する

DataTransferItem.getAsFile() メソッドは、ドラッグデータの項目の File オブジェクトを返します。項目がファイルでない場合、このメソッドは null を返します。ファイルを読み取ることはできますが、書き戻すことはできません。このメソッドには、ディレクトリをサポートしていないという欠点があります。

Browser Support

  • Chrome: 11.
  • Edge: 12.
  • Firefox: 50.
  • Safari: 5.1.

Source

プログレッシブ エンハンスメント

次のスニペットでは、最新の File System Access API の DataTransferItem.getAsFileSystemHandle() メソッドがサポートされている場合はそのメソッドを使用し、サポートされていない場合は非標準の DataTransferItem.webkitGetAsEntry() メソッドにフォールバックし、最後に従来の DataTransferItem.getAsFile() メソッドにフォールバックします。各 handle のタイプは次のいずれかになる可能性があるため、必ず確認してください。

  • 最新のコードパスが選択されている場合は FileSystemFileHandle。
  • 従来のコードパスが選択されている場合は File。

すべてのタイプに name プロパティがあるため、ログに記録しても問題なく、常に機能します。

// Run feature detection.
const supportsFileSystemAccessAPI =
  'getAsFileSystemHandle' in DataTransferItem.prototype;

// This is the drag and drop zone.
const elem = document.querySelector('main');

  // Prevent navigation.
elem.addEventListener('dragover', (e) => {
  e.preventDefault();
});

// Visually highlight the drop zone.
elem.addEventListener('dragenter', (e) => {
  elem.style.outline = 'solid red 1px';
});

// Visually unhighlight the drop zone.
elem.addEventListener('dragleave', (e) => {
  elem.style.outline = '';
});

// This is where the drop is handled.
elem.addEventListener('drop', async (e) => {
  // Prevent navigation.
  e.preventDefault();
  // Unhighlight the drop zone.
  elem.style.outline = '';
  // Prepare an array of promises…
  const fileHandlesPromises = [...e.dataTransfer.items]
    // …by including only files (where file misleadingly means actual file _or_
    // directory)…
    .filter((item) => item.kind === 'file')
    // …and, depending on previous feature detection…
    .map((item) =>
      supportsFileSystemAccessAPI
        // …either get a modern `FileSystemHandle`…
        ? item.getAsFileSystemHandle()
        // …or a classic `File`.
        : item.getAsFile(),
    );
  // Loop over the array of promises.
  for await (const handle of fileHandlesPromises) {
    // This is where we can actually exclusively act on the files.
    if (handle.kind === 'file' || handle.isFile) {
      console.log(`File: ${handle.name}`);
    }
  }
});

関連情報

デモ

HTML

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>How to drag and drop files</title>
  </head>
  <body>
    <main>
      <h1>How to drag and drop files</h1>
      <p>Drag and drop one or multiple files onto the page.</p>
      <pre></pre>
    </main>
  </body>
</html>

CSS


        :root {
  color-scheme: dark light;
  box-sizing: border-box;
}

*,
*:before,
*:after {
  box-sizing: inherit;
}

body {
  margin: 0;
  padding: 1rem;
  font-family: system-ui, sans-serif;
  line-height: 1.5;
  min-height: 100vh;
  display: flex;
  flex-direction: column;
}

img,
video {
  height: auto;
  max-width: 100%;
}

main {
  flex-grow: 1;
}

footer {
  margin-top: 1rem;
  border-top: solid CanvasText 1px;
  font-size: 0.8rem;
}

JS


        const supportsFileSystemAccessAPI =
  "getAsFileSystemHandle" in DataTransferItem.prototype;
const supportsWebkitGetAsEntry =
  "webkitGetAsEntry" in DataTransferItem.prototype;

const elem = document.querySelector("main");
const debug = document.querySelector("pre");

elem.addEventListener("dragover", (e) => {
  // Prevent navigation.
  e.preventDefault();
});

elem.addEventListener("dragenter", (e) => {
  elem.style.outline = "solid red 1px";
});

elem.addEventListener("dragleave", (e) => {
  elem.style.outline = "";
});

elem.addEventListener("drop", async (e) => {
  e.preventDefault();
  elem.style.outline = "";
  const fileHandlesPromises = [...e.dataTransfer.items]
    .filter((item) => item.kind === "file")
    .map((item) =>
      supportsFileSystemAccessAPI
        ? item.getAsFileSystemHandle()
        : supportsWebkitGetAsEntry
        ? item.webkitGetAsEntry()
        : item.getAsFile()
    );

  for await (const handle of fileHandlesPromises) {
    if (handle.kind === "directory" || handle.isDirectory) {
      console.log(`Directory: ${handle.name}`);
      debug.textContent += `Directory: ${handle.name}\n`;
    } else {
      console.log(`File: ${handle.name}`);
      debug.textContent += `File: ${handle.name}\n`;
    }
  }
});