CKTIS / JavaScript
DataTransfer: dovoljena dejanja, učinek spusta in podatki
Izvor določi dovoljena dejanja, cilj izbere eno, `setData()` pa shrani besedilo, ki ga lahko cilj prebere ob spustu.
Različica: ECMAScript 2024 and the current web platform; runtime support varies
Sintaksa
// 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 omogoča dostop do objekta DataTransfer dogodka povleci in spusti. Ta spletni API določa standard HTML in ni del ECMAScript 2024. Preveri podporo v ciljnem izvajalnem okolju.
Izvor: nastavi effectAllowed sinhrono v dragstart. copy, move in link dovoljujejo kopiranje, premikanje oziroma ustvarjanje povezave. copyLink, copyMove in linkMove dovoljujejo eno od dveh navedenih dejanj, all dovoljuje vsa tri, none pa nobenega. Tudi začetna vrednost uninitialized dovoljuje vsa tri, vendar lahko vpliva na privzeto izbiro. Neveljavne vrednosti in poskusi pisanja zunaj načina za branje in pisanje se prezrejo.
Cilj: če v dragover sprejmeš vlečenje, pokliči preventDefault() in nastavi dropEffect na dovoljeno vrednost copy, move ali link. none pomeni, da dejanja ni; druge vrednosti se prezrejo. Brskalnik za dragenter in dragover določi začetno vrednost glede na dovoljena dejanja in pravila platforme, na primer glede na modifikacijske tipke. Nezdružljiva izbira ne omogoči spusta. Ob sprejetem drop pokliči preventDefault() in izvedi dejanje v svoji kodi: nastavitev move sama ne premakne elementa DOM.
Podatki: setData(format, data) sprejme dva niza in vrne undefined. Doda besedilo za določeno obliko zapisa ali zamenja obstoječe besedilo te oblike. Črke ASCII v imenu oblike zapisa se pretvorijo v male črke; text in url sta drugi imeni za text/plain in text/uri-list. Če v shrambo ni mogoče pisati, metoda ne spremeni ničesar.
Besedilo zapiši sinhrono v dragstart. Na cilju ga preberi sinhrono z getData() v drop, ko je shramba samo za branje. Med dragover lahko preveriš types, vsebine pa ne moreš prebrati. Za poznejšo uporabo shrani prebrani niz, ne objekta dogodka. Spuščenim podatkom ne zaupaj in navadno besedilo prikaži z textContent.
Primeri
(() => {
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.
}
})();Rezultat
copy: card-34
Zaženi primer v konzoli brskalnika na prazni strani. Simulirani spust v konzolo izpiše `copy: card-34` in v polju obnovi besedilo »Drop here«. Nato z miško povleci »Drag card-34« v to polje. Polje prikaže `card-34`, izvor ostane na mestu, konzola pa znova izpiše `copy: card-34`.
Povezane lekcije
- JavaScript · Lekcija 34 · Srednja · Različica: 3