Como arrastar e soltar diretórios

Thomas Steiner

As interfaces HTML Drag and Drop permitem que aplicativos da Web aceitem arquivos arrastados e soltos em uma página da Web. Durante uma operação de arrastar e soltar, os itens de arquivo e diretório arrastados são associados a entradas de arquivo e entradas de diretório, respectivamente. Quando se trata de arrastar e soltar arquivos no navegador, há duas maneiras de fazer isso: a moderna e a clássica.

A maneira moderna

Como usar o método DataTransferItem.getAsFileSystemHandle() da API File System Access

O método DataTransferItem.getAsFileSystemHandle() retorna uma promessa com um objeto FileSystemFileHandle se o item arrastado for um arquivo e uma promessa com um objeto FileSystemDirectoryHandle se o item arrastado for um diretório. Esses identificadores permitem ler e, opcionalmente, gravar de volta no arquivo ou diretório. A interface Drag and Drop's DataTransferItem.kind será "file" para arquivos e diretórios, enquanto a API File System Access's FileSystemHandle.kind será "file" para arquivos e "directory" para diretórios.

Browser Support

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

Source

A maneira clássica

Como usar o método não padrão DataTransferItem.webkitGetAsEntry()

O método DataTransferItem.webkitGetAsEntry() retorna o FileSystemFileEntry do item de dados de arrastar se o item for um arquivo e FileSystemDirectoryEntry se o item for um diretório. Embora seja possível ler o arquivo ou diretório, não há como gravar de volta neles. Esse método tem a desvantagem de não estar na faixa de padrões, mas tem a vantagem de oferecer suporte a diretórios.

Browser Support

  • Chrome: 13.
  • Edge: 14.
  • Firefox: 50.
  • Safari: 11.1.

Source

Aprimoramento progressivo

O snippet abaixo usa o método DataTransferItem.getAsFileSystemHandle() da API File System Access moderna quando ele é compatível. Em seguida, ele volta para o método não padrão DataTransferItem.webkitGetAsEntry() e, por fim, para o método clássico DataTransferItem.getAsFile(). Verifique o tipo de cada handle, já que ele pode ser um dos seguintes:

  • FileSystemDirectoryHandle quando o caminho de código moderno é escolhido.
  • FileSystemDirectoryEntry quando o caminho de código não padrão é escolhido.

Todos os tipos têm uma propriedade name, então o registro é bom e sempre funciona.

// Run feature detection.
const supportsFileSystemAccessAPI =
  'getAsFileSystemHandle' in DataTransferItem.prototype;
const supportsWebkitGetAsEntry =
  'webkitGetAsEntry' 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();
  if (!supportsFileSystemAccessAPI && !supportsWebkitGetAsEntry) {
    // Cannot handle directories.
    return;
  }
  // 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 `FileSystemFileEntry`.
        : item.webkitGetAsEntry(),
    );
  // Loop over the array of promises.
  for await (const handle of fileHandlesPromises) {
    // This is where we can actually exclusively act on the directories.
    if (handle.kind === 'directory' || handle.isDirectory) {
      console.log(`Directory: ${handle.name}`);
    }
  }
});

Leitura adicional

Demonstração

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 directories</title>
  </head>
  <body>
    <main>
      <h1>How to drag and drop directories</h1>
      <p>Drag and drop one or multiple files or directories 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`;
    }
  }
});