CKTIS / JavaScript
DataTransfer: operaciones permitidas, efecto de la suelta y datos
El origen indica qué operaciones se permiten, el destino elige una y `setData()` guarda el texto que este puede leer al soltar.
Versión: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxis
// 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 da acceso al objeto DataTransfer de un evento de arrastrar y soltar. Esta API de la plataforma web está definida en HTML y no forma parte de ECMAScript 2024. Comprueba que sea compatible con el entorno de ejecución de destino.
Origen: asigna effectAllowed de forma síncrona en dragstart. copy, move y link permiten copiar, mover y crear un enlace, respectivamente. copyLink, copyMove y linkMove permiten cualquiera de las dos operaciones que nombran, all permite las tres y none no permite ninguna. El valor inicial uninitialized también permite las tres, pero puede afectar a la elección predeterminada. Se ignoran los valores no válidos y las escrituras fuera del modo de lectura y escritura.
Destino: en dragover, si aceptas el arrastre, llama a preventDefault() y asigna a dropEffect un valor permitido: copy, move o link. none significa que no hay operación; los demás valores se ignoran. El navegador inicializa esta propiedad para dragenter y dragover según las operaciones permitidas y las convenciones de la plataforma, como las teclas modificadoras. Una elección incompatible no permite soltar. En un drop aceptado, llama a preventDefault() y ejecuta tú la operación: asignar move no mueve un elemento del DOM.
Datos: setData(format, data) recibe dos cadenas y devuelve undefined. Añade texto para un formato o sustituye el texto que ya tenía ese formato. Las letras ASCII del formato se convierten a minúsculas; text y url son alias de text/plain y text/uri-list. Si el almacén no admite escritura, el método no cambia nada.
Escribe el texto de forma síncrona en dragstart. En el destino, léelo de forma síncrona con getData() en drop, cuando el almacén es de solo lectura. Durante dragover puedes consultar types, pero no leer el contenido. Guarda la cadena obtenida, no el objeto del evento, si vas a usarla después. Trata los datos soltados como no fiables y muestra el texto plano con textContent.
Ejemplos
(() => {
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.
}
})();Resultado
copy: card-34
Ejecuta el ejemplo en la consola del navegador en una página en blanco. Una suelta simulada muestra `copy: card-34` en la consola y restablece el texto «Drop here». Después, arrastra «Drag card-34» con el ratón hasta ese recuadro. El recuadro muestra `card-34`, el origen permanece en su sitio y la consola vuelve a mostrar `copy: card-34`.
Lecciones relacionadas
- JavaScript · Lección 34 · Intermedio · Versión: 3