CKTIS / JavaScript
DataTransfer : opérations autorisées, effet du dépôt et données
La source définit les opérations autorisées, la cible en choisit une et `setData()` stocke le texte que la cible pourra lire au dépôt.
Version : 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 donne accès à l’objet DataTransfer d’un événement de glisser-déposer. Cette API du Web est définie par la norme HTML et ne fait pas partie d’ECMAScript 2024. Vérifiez sa prise en charge dans l’environnement cible.
Source : définissez effectAllowed dans la partie synchrone de dragstart. copy, move et link autorisent respectivement la copie, le déplacement et la création d’un lien. copyLink, copyMove et linkMove autorisent l’une des deux opérations nommées, all autorise les trois et none n’en autorise aucune. La valeur initiale uninitialized permet aussi les trois, mais peut influer sur le choix par défaut. Les valeurs invalides et les écritures hors du mode lecture-écriture sont ignorées.
Cible : dans dragover, si vous acceptez le glissement, appelez preventDefault() et attribuez à dropEffect une opération autorisée parmi copy, move et link. none indique l’absence d’opération ; les autres valeurs sont ignorées. Le navigateur initialise cette propriété pour dragenter et dragover selon les opérations autorisées et les conventions de la plateforme, notamment les touches de modification. Un choix incompatible ne permet pas le dépôt. Lors d’un drop accepté, appelez preventDefault() et réalisez vous-même l’opération : attribuer move ne déplace pas un élément du DOM.
Données : setData(format, data) prend deux chaînes et renvoie undefined. La méthode ajoute du texte pour un format ou remplace le texte déjà associé à ce format. Les lettres ASCII du format sont converties en minuscules ; text et url sont des alias de text/plain et text/uri-list. Si le magasin n’est pas accessible en écriture, la méthode ne change rien.
Écrivez le texte de façon synchrone dans dragstart. Côté cible, lisez-le de façon synchrone avec getData() dans drop, lorsque le magasin est en lecture seule. Dans dragover, consultez types plutôt que le contenu. Pour une utilisation ultérieure, conservez la chaîne lue, pas l’objet événement. Considérez les données déposées comme non fiables et affichez le texte brut avec textContent.
Exemples
(() => {
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.
}
})();Résultat
copy: card-34
Exécutez l’exemple dans la console du navigateur sur une page vierge. Un dépôt simulé affiche `copy: card-34` dans la console et rétablit le texte « Drop here ». Faites ensuite glisser « Drag card-34 » à la souris vers cette zone. La zone affiche `card-34`, la source reste en place et la console affiche de nouveau `copy: card-34`.
Leçons associées
- JavaScript · Leçon 34 · Intermédiaire · Version : 3