CKTIS / JavaScript
DataTransfer: dozwolone operacje, efekt upuszczenia i dane
Źródło określa dozwolone operacje, cel wybiera jedną z nich, a `setData()` zapisuje tekst, który cel może odczytać przy upuszczeniu.
Wersja: ECMAScript 2024 and the current web platform; runtime support varies
Składnia
// 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 udostępnia obiekt DataTransfer zdarzenia przeciągania. Jest to interfejs platformy Web zdefiniowany w standardzie HTML, a nie część ECMAScript 2024. Sprawdź obsługę w środowisku docelowym.
Źródło: w synchronicznej obsłudze dragstart ustaw effectAllowed. Wartości copy, move i link pozwalają odpowiednio na kopiowanie, przeniesienie lub utworzenie odsyłacza. copyLink, copyMove i linkMove pozwalają na jedną z dwóch wskazanych operacji, all na wszystkie trzy, a none na żadną. Początkowe uninitialized również dopuszcza wszystkie trzy, ale może wpływać na wybór domyślny. Nieprawidłowe wartości i próby zapisu poza trybem odczytu i zapisu są ignorowane.
Cel: w dragover wywołaj preventDefault(), jeśli akceptujesz przeciągnięcie, i ustaw dropEffect na dozwolone copy, move lub link. none oznacza brak operacji; pozostałe wartości są ignorowane. Przeglądarka ustala wartość początkową dla dragenter i dragover na podstawie dozwolonych operacji i zasad platformy, np. z uwzględnieniem klawiszy modyfikujących. Niedozwolony wybór nie umożliwia upuszczenia. Przy zaakceptowanym drop wywołaj preventDefault() i wykonaj operację w kodzie: samo ustawienie move nie przenosi elementu DOM.
Dane: setData(format, data) przyjmuje dwa ciągi znaków i zwraca undefined. Dodaje tekst dla danego formatu lub zastępuje istniejący tekst tego formatu. Litery ASCII w nazwie formatu są zamieniane na małe; text i url to aliasy text/plain i text/uri-list. Jeśli magazyn nie jest zapisywalny, metoda niczego nie zmienia.
Zapisuj tekst synchronicznie w dragstart, a w celu odczytuj go synchronicznie przez getData() w drop, gdy magazyn jest tylko do odczytu. W trakcie dragover można sprawdzić types, ale nie odczytać treści. Zachowaj odczytany ciąg, a nie obiekt zdarzenia, do późniejszego użycia. Traktuj upuszczone dane jako niezaufane i wyświetlaj zwykły tekst przez textContent.
Przykłady
(() => {
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.
}
})();Wynik
copy: card-34
Uruchom przykład w konsoli przeglądarki na pustej stronie. Symulowane upuszczenie wypisze `copy: card-34` i przywróci napis „Drop here”. Następnie przeciągnij „Drag card-34” myszą do tego pola. Pole wyświetli `card-34`, źródło pozostanie na miejscu, a konsola ponownie wypisze `copy: card-34`.
Powiązane lekcje
- JavaScript · Lekcja 34 · Średniozaawansowany · Wersja: 3