WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

DataTransfer: erlaubte Aktionen, Ablegeeffekt und Ziehdaten

Die Quelle legt die erlaubten Aktionen fest, das Ziel wählt eine davon, und `setData()` speichert den Text, den das Ziel beim Ablegen lesen kann.

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

Syntax

// 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 liefert das DataTransfer-Objekt eines Drag-and-drop-Ereignisses. Diese Web-API ist im HTML-Standard definiert und gehört nicht zu ECMAScript 2024. Prüfe die Unterstützung in deiner Zielumgebung.

Quelle: Setze effectAllowed synchron in dragstart. copy, move und link erlauben Kopieren, Verschieben beziehungsweise Verknüpfen. copyLink, copyMove und linkMove erlauben jeweils eine der beiden genannten Aktionen, all alle drei und none keine. Der Anfangswert uninitialized erlaubt ebenfalls alle drei, kann aber die Standardauswahl beeinflussen. Ungültige Werte und Schreibversuche außerhalb des Lese-/Schreibmodus werden ignoriert.

Ziel: Rufe in dragover bei Annahme des Ziehvorgangs preventDefault() auf und setze dropEffect auf ein erlaubtes copy, move oder link. none bedeutet keine Aktion; andere Werte werden ignoriert. Der Browser initialisiert die Eigenschaft bei dragenter und dragover anhand der erlaubten Aktionen und der Plattformkonventionen, etwa für Modifikatortasten. Eine unzulässige Auswahl ermöglicht kein Ablegen. Rufe bei einem akzeptierten drop preventDefault() auf und führe die Aktion selbst aus: move allein verschiebt kein DOM-Element.

Daten: setData(format, data) erwartet zwei Zeichenfolgen und gibt undefined zurück. Die Methode fügt Text für ein Format hinzu oder ersetzt vorhandenen Text dieses Formats. ASCII-Buchstaben im Format werden kleingeschrieben; text und url sind Aliasse für text/plain und text/uri-list. Ist der Datenspeicher nicht beschreibbar, ändert die Methode nichts.

Schreibe den Text synchron in dragstart. Lies ihn am Ziel synchron mit getData() in drop, wenn der Datenspeicher schreibgeschützt ist. Bei dragover kannst du types prüfen, aber nicht den Inhalt lesen. Bewahre für später die gelesene Zeichenfolge auf, nicht das Ereignisobjekt. Behandle abgelegte Daten als nicht vertrauenswürdig und zeige reinen Text mit textContent an.

Beispiele

(() => {
  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.
  }
})();

Ergebnis

copy: card-34

Führe das Beispiel in der Browserkonsole auf einer leeren Seite aus. Ein simuliertes Ablegen gibt `copy: card-34` aus und setzt das Feld auf „Drop here“ zurück. Ziehe anschließend „Drag card-34“ mit der Maus auf das Feld. Das Feld zeigt `card-34`, die Quelle bleibt an ihrem Platz, und die Konsole gibt erneut `copy: card-34` aus.

Zugehörige Lektionen

  • JavaScript · Lektion 34 · Mittlere Stufe · Version: 3

Quellen