DataTransfer:dropEffect 属性
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since 2015年7月.
DataTransfer.dropEffect 属性控制在拖放操作中给用户的反馈(通常是视觉上的)。它会影响在拖动过程中光标的手势。例如,当用户在一个放置目标元素上悬停时,浏览器的光标可能会预示了将会发生什么操作。
当 DataTransfer 被创建时,dropEffect 被设置为一个字符串。读取该值会返回它的当前值。设置该值时,若新值是下面列出的值中的一个,这个属性的值就会被设置为这个新的值,其他的值都会被忽略。
对于 dragenter 和 dragover 事件,dropEffect 会根据用户的请求的行为进行初始化。具体如何初始化和浏览器平台有关,但是通常来讲,用户可以通过按住修改键(如 alt 键)来修改预期行为。当我们期望得到一个指定的行为时而不是用户的请求行为时,可以通过 dragenter 和 dragover 事件的事件处理器处理修改 dropEffect 的值。
对于 drop 和 dragend 事件,dropEffect 会被设置为想要得到的值,即最后一次 dragenter 或 dragover 事件后 dropEffect 的值。例如,在一个 dragend 事件中,如果期望得到的 dropEffect 是“move”,那么被拖动的数据会从源中移除。
语法
dataTransfer.dropEffect;
值
一个代表拖动操作效果的字符串。可能的值有:
将任何其他值赋给 dropEffect 都没有效果,此时只会保留旧值。
示例
下述示例演示了 dropEffect 和 effectAllowed 属性的用法。
HTML
<div>
<p id="source" draggable="true">
选中这一元素,拖动它到可放置区域,然后释放选择以移动该元素。
</p>
</div>
<div id="target">可放置区域</div>
CSS
div {
margin: 0em;
padding: 2em;
}
#source {
color: blue;
border: 1px solid black;
}
#target {
border: 1px solid black;
}
JavaScript
const source = document.getElementById("source");
const target = document.getElementById("target");
source.addEventListener("dragstart", (ev) => {
console.log(
`dragStart:dropEffect = ${ev.dataTransfer.dropEffect};effectAllowed = ${ev.dataTransfer.effectAllowed}`,
);
// 将该元素的 id 添加到拖动负载中,以便放置事件的处理器能分清要将哪个元素添加到树中
ev.dataTransfer.setData("text", ev.target.id);
ev.dataTransfer.effectAllowed = "move";
});
target.addEventListener("drop", (ev) => {
console.log(
`drop:dropEffect = ${ev.dataTransfer.dropEffect};effectAllowed = ${ev.dataTransfer.effectAllowed}`,
);
ev.preventDefault();
// 获取目标的 id 并将被移动的元素添加到目标的 DOM 中
const data = ev.dataTransfer.getData("text");
ev.target.appendChild(document.getElementById(data));
});
target.addEventListener("dragover", (ev) => {
console.log(
`dragOver:dropEffect = ${ev.dataTransfer.dropEffect};effectAllowed = ${ev.dataTransfer.effectAllowed}`,
);
ev.preventDefault();
// 设置 dropEffect 为 move
ev.dataTransfer.dropEffect = "move";
});
规范
| Specification |
|---|
| HTML> # dom-datatransfer-dropeffect-dev> |