База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / JavaScript

DataTransfer: разрешени операции, ефект при пускане и данни

Източникът определя разрешените операции, целта избира една, а `setData()` записва текста, който целта може да прочете при пускане.

Версия: ECMAScript 2024 and the current web platform; runtime support varies

Синтаксис

// 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 дава достъп до обекта DataTransfer на събитие за плъзгане и пускане. Този уеб интерфейс е дефиниран в стандарта HTML и не е част от ECMAScript 2024. Провери поддръжката в целевата среда за изпълнение.

Източник: задай effectAllowed синхронно в dragstart. Стойностите copy, move и link разрешават съответно копиране, преместване и създаване на връзка. copyLink, copyMove и linkMove разрешават една от двете посочени операции, all разрешава и трите, а none — нито една. Началната стойност uninitialized също разрешава и трите, но може да повлияе на избора по подразбиране. Невалидните стойности и записите извън режима за четене и запис се пренебрегват.

Цел: ако приемаш плъзгането в dragover, извикай preventDefault() и задай dropEffect на разрешена стойност: copy, move или link. none означава, че няма операция; останалите стойности се пренебрегват. Браузърът задава началната стойност за dragenter и dragover според разрешените операции и правилата на платформата, например според натиснатите модифициращи клавиши. Несъвместим избор не позволява пускане. При приет drop извикай preventDefault() и изпълни операцията в своя код: задаването на move не премества елемент от DOM.

Данни: setData(format, data) приема два низа и връща undefined. Методът добавя текст за даден формат или заменя съществуващия текст за същия формат. ASCII буквите в името на формата се преобразуват в малки; text и url са алтернативни имена на text/plain и text/uri-list. Ако хранилището не позволява запис, методът не променя нищо.

Запиши текста синхронно в dragstart. В целта го прочети синхронно с getData() в drop, когато хранилището е само за четене. В dragover можеш да провериш types, но не и да прочетеш съдържанието. За по-късна употреба запази прочетения низ, а не обекта на събитието. Не се доверявай на пуснатите данни и показвай обикновен текст с textContent.

Примери

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

Резултат

copy: card-34

Изпълни примера в конзолата на браузъра на празна страница. Симулирано пускане извежда `copy: card-34` в конзолата и възстановява надписа „Drop here“. След това плъзни „Drag card-34“ с мишката в полето. Полето показва `card-34`, източникът остава на място, а конзолата отново извежда `copy: card-34`.

Свързани уроци

  • JavaScript · Урок 34 · Средно · Версия: 3

Източници