Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

DataTransfer: povolené operace, efekt upuštění a data

Zdroj určí povolené operace, cíl jednu vybere a `setData()` uloží text, který si cíl může při upuštění přečíst.

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

Syntaxe

// 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 zpřístupňuje objekt DataTransfer události přetažení. Toto webové API definuje standard HTML, nikoli ECMAScript 2024. Ověř podporu v cílovém prostředí.

Zdroj: nastav effectAllowed synchronně v dragstart. Hodnoty copy, move a link povolují kopírování, přesun a vytvoření odkazu. copyLink, copyMove a linkMove povolují jednu ze dvou uvedených operací, all povoluje všechny tři a none žádnou. Počáteční uninitialized rovněž povoluje všechny tři, ale může ovlivnit výchozí výběr. Neplatné hodnoty i zápisy mimo režim čtení a zápisu se ignorují.

Cíl: pokud v dragover přetažení přijímáš, zavolej preventDefault() a nastav dropEffect na povolené copy, move nebo link. none znamená žádnou operaci; jiné hodnoty se ignorují. Prohlížeč nastavuje počáteční hodnotu pro dragenter a dragover podle povolených operací a zvyklostí platformy, například podle modifikačních kláves. Nepovolená volba upuštění neumožní. Při přijatém drop zavolej preventDefault() a operaci proveď vlastním kódem: samotné nastavení move prvek DOM nepřesune.

Data: setData(format, data) přijímá dva řetězce a vrací undefined. Přidá text pro daný formát nebo nahradí stávající text téhož formátu. Písmena ASCII v názvu formátu se převádějí na malá; text a url jsou aliasy pro text/plain a text/uri-list. Pokud do úložiště nelze zapisovat, metoda nic nezmění.

Text zapisuj synchronně v dragstart. Na cíli ho čti synchronně pomocí getData() v drop, kdy je úložiště jen pro čtení. Během dragover můžeš kontrolovat types, ne však číst obsah. Pro pozdější použití si ulož načtený řetězec, nikoli objekt události. Data z přetažení považuj za nedůvěryhodná a prostý text zobrazuj přes textContent.

Příklady

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

Výsledek

copy: card-34

Spusť příklad v konzoli prohlížeče na prázdné stránce. Simulované upuštění vypíše `copy: card-34` a vrátí do pole text „Drop here“. Pak do pole přetáhni myší „Drag card-34“. Pole zobrazí `card-34`, zdroj zůstane na místě a konzole znovu vypíše `copy: card-34`.

Související lekce

  • JavaScript · Lekce 34 · Středně pokročilá · Verze: 3

Zdroje