Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

DataTransfer: operazioni consentite, effetto del rilascio e dati

L’origine indica le operazioni consentite, la destinazione ne sceglie una e `setData()` salva il testo da leggere al rilascio.

Versione: ECMAScript 2024 and the current web platform; runtime support varies

Sintassi

// Source: write to this dragstart event's data store.
source.addEventListener("dragstart", (event) => {
  const transfer = event.dataTransfer;
  transfer.effectAllowed = "copyMove";
  transfer.setData("text/plain", "card-34");
});

// Target: accept a compatible drag using this dragover event.
target.addEventListener("dragover", (event) => {
  const transfer = event.dataTransfer;
  if (!transfer.types.includes("text/plain")) return;
  event.preventDefault();
  transfer.dropEffect = "copy";
});

// Target: read from this drop event's data store.
target.addEventListener("drop", (event) => {
  event.preventDefault();
  const text = event.dataTransfer.getData("text/plain");
});

event.dataTransfer espone l’oggetto DataTransfer di un evento di trascinamento. Questa API della piattaforma Web è definita dallo standard HTML e non fa parte di ECMAScript 2024. Verifica il supporto nell’ambiente di esecuzione di destinazione.

Origine: imposta effectAllowed in modo sincrono in dragstart. copy, move e link consentono rispettivamente di copiare, spostare o creare un collegamento. copyLink, copyMove e linkMove consentono una delle due operazioni indicate, all le consente tutte e tre, none nessuna. Anche il valore iniziale uninitialized le consente tutte e tre, ma può influire sulla scelta predefinita. I valori non validi e le scritture fuori dalla modalità di lettura e scrittura vengono ignorati.

Destinazione: in dragover, se accetti il trascinamento, chiama preventDefault() e imposta dropEffect su un valore consentito tra copy, move e link. none indica nessuna operazione; gli altri valori vengono ignorati. Il browser inizializza questa proprietà per dragenter e dragover in base alle operazioni consentite e alle convenzioni della piattaforma, come l’uso dei tasti modificatori. Una scelta incompatibile non consente il rilascio. In un drop accettato, chiama preventDefault() ed esegui tu l’operazione: impostare move non sposta un elemento del DOM.

Dati: setData(format, data) riceve due stringhe e restituisce undefined. Aggiunge del testo per un formato o sostituisce quello già presente per lo stesso formato. Le lettere ASCII del formato sono convertite in minuscolo; text e url sono alias di text/plain e text/uri-list. Se l’archivio non è scrivibile, il metodo non cambia nulla.

Scrivi il testo in modo sincrono in dragstart. Alla destinazione, leggilo in modo sincrono con getData() in drop, quando l’archivio è in sola lettura. Durante dragover puoi controllare types, ma non leggere il contenuto. Per un uso successivo, conserva la stringa letta, non l’oggetto evento. Tratta i dati rilasciati come non attendibili e usa textContent per visualizzare il testo semplice.

Esempi

(() => {
  const source = document.createElement("p");
  source.textContent = "Drag card-34";
  source.draggable = true;
  source.style.cursor = "grab";

  const target = document.createElement("div");
  const prompt = "Drop here";
  target.textContent = prompt;
  target.style.cssText = "border: 2px dashed; padding: 24px;";

  const format = "text/plain";
  source.addEventListener("dragstart", (event) => {
    event.dataTransfer.effectAllowed = "copy";
    event.dataTransfer.setData(format, "card-34");
  });

  function acceptCopy(event) {
    if (!event.dataTransfer.types.includes(format)) return;
    event.preventDefault();
    event.dataTransfer.dropEffect = "copy";
  }
  target.addEventListener("dragenter", acceptCopy);
  target.addEventListener("dragover", acceptCopy);

  target.addEventListener("drop", (event) => {
    event.preventDefault();
    const text = event.dataTransfer.getData(format);
    if (!text) return;
    target.textContent = text;
    console.log(`${event.dataTransfer.dropEffect}: ${text}`);
  });

  document.body.append(source, target);

  // Exercise the handlers once without mouse input. These synthetic events
  // share an explicitly created store; they do not start a native drag.
  const transfer = new DataTransfer();
  function dispatchDrag(element, type) {
    return element.dispatchEvent(new DragEvent(type, {
      bubbles: true,
      cancelable: true,
      dataTransfer: transfer,
    }));
  }

  if (!dispatchDrag(source, "dragstart")) return;
  dispatchDrag(target, "dragenter");
  const accepted = !dispatchDrag(target, "dragover");
  if (accepted && transfer.effectAllowed === "copy" && transfer.dropEffect === "copy") {
    dispatchDrag(target, "drop");
    target.textContent = prompt; // Reset the box for a native drag.
  }
})();

Risultato

copy: card-34

Esegui l’esempio nella console del browser su una pagina vuota. Un rilascio simulato stampa `copy: card-34` nella console e ripristina il testo «Drop here». Poi trascina «Drag card-34» con il mouse su quel riquadro. Il riquadro mostra `card-34`, l’origine resta al suo posto e la console stampa di nuovo `copy: card-34`.

Lezioni correlate

  • JavaScript · Lezione 34 · Intermedio · Versione: 3

Fonti