CKTIS / JavaScript
DataTransfer: toegestane bewerkingen, neerzeteffect en sleepgegevens
De bron bepaalt welke bewerkingen zijn toegestaan, het doel kiest er een en `setData()` slaat de tekst op die het doel bij het neerzetten kan lezen.
Versie: 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 geeft toegang tot het DataTransfer-object van een sleepgebeurtenis. Deze web-API is vastgelegd in de HTML-standaard en maakt geen deel uit van ECMAScript 2024. Controleer de ondersteuning in je doelomgeving.
Bron: stel effectAllowed synchroon in tijdens dragstart. copy, move en link staan respectievelijk kopiëren, verplaatsen en koppelen toe. copyLink, copyMove en linkMove staan elk een van de twee genoemde bewerkingen toe, all staat ze alle drie toe en none staat er geen toe. De beginwaarde uninitialized staat ze ook alle drie toe, maar kan de standaardkeuze beïnvloeden. Ongeldige waarden en schrijfpogingen buiten de lees-schrijfmodus worden genegeerd.
Doel: roep in dragover bij acceptatie preventDefault() aan en stel dropEffect in op een toegestane waarde: copy, move of link. none betekent geen bewerking; andere waarden worden genegeerd. De browser bepaalt de beginwaarde voor dragenter en dragover aan de hand van de toegestane bewerkingen en platformconventies, zoals het gebruik van modificatietoetsen. Een onverenigbare keuze maakt neerzetten niet mogelijk. Roep bij een geaccepteerde drop preventDefault() aan en voer de bewerking zelf uit: move instellen verplaatst geen DOM-element.
Gegevens: setData(format, data) neemt twee tekenreeksen aan en geeft undefined terug. De methode voegt tekst toe voor een indeling of vervangt de bestaande tekst voor die indeling. ASCII-letters in de indeling worden omgezet naar kleine letters; text en url zijn aliassen voor text/plain en text/uri-list. Als het gegevensarchief niet beschrijfbaar is, verandert de methode niets.
Schrijf de tekst synchroon in dragstart. Lees de tekst op het doel synchroon met getData() in drop, wanneer het gegevensarchief alleen-lezen is. Tijdens dragover kun je types bekijken, maar niet de inhoud lezen. Bewaar voor later de opgehaalde tekenreeks, niet het gebeurtenisobject. Beschouw neergezette gegevens als onbetrouwbaar en toon platte tekst met textContent.
Voorbeelden
(() => {
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.
}
})();Resultaat
copy: card-34
Voer het voorbeeld uit in de browserconsole op een lege pagina. Een gesimuleerde neerzetactie toont `copy: card-34` in de console en zet de tekst van het vak terug op ‘Drop here’. Sleep daarna ‘Drag card-34’ met de muis naar het vak. Het vak toont `card-34`, de bron blijft op zijn plaats en de console toont opnieuw `copy: card-34`.
Gerelateerde lessen
- JavaScript · Les 34 · Gemiddeld · Versie: 3