介绍
Drag API 是 HTML5 提供的一组用于实现拖拽操作的接口和事件，它允许用户通过鼠标或触摸设备将元素拖动到指定的位置。通过Drag API，我们可以监听拖拽的开始、过程和结束等事件，并在这些事件的处理程序中编写自定义的逻辑。
Drag API还提供了方法和属性，用于控制拖拽操作的行为和状态。通过使用Drag API，我们可以为网页添加直观、交互性强的拖拽功能，提升用户体验和界面的可操作性。
基本概念和术语
| 概念 | 简介 |
|---|---|
| 拖拽源 | 拖动的元素 |
| 目标区域 | 接受拖动元素的终点 |
| DataTransfer | 传递拖拽数据的中介 |
拖拽源的属性和事件
| 属性/事件 | 简介 |
|---|---|
| draggable 属性 | 用于指定元素是否可拖动。设置为 true 时，元素可以被拖动；设置为 false 时，元素不可拖动。 |
| dragstart 事件 | 拖动操作开始时触发的事件。可以在该事件处理程序中设置要传输的数据，并进行一些其他初始化操作。 |
| drag 事件 | 拖动过程中持续触发的事件。通常用于实时更新拖动元素的位置或执行其他与拖动相关的操作。 |
| dragend 事件 | 拖动操作结束时触发的事件。可以在该事件处理程序中进行一些清理工作或执行最终的操作。 |
目标区域的属性和事件
| 事件 | 简介 |
|---|---|
| dragenter 事件 | 拖动元素进入目标区域时触发的事件。通常用于在进入目标区域时添加一些视觉效果或样式变化。 |
| dragover 事件 | 拖动元素在目标区域上方移动时持续触发的事件。通过阻止默认行为可以允许拖放操作发生。 |
| dragleave 事件 | 拖动元素离开目标区域时触发的事件。通常用于在离开目标区域时移除添加的视觉效果或样式变化。 |
| drop 事件 | 在目标区域释放拖动元素时触发的事件。可以在该事件处理程序中获取传输的数据并进行处理。 |
| ## DataTransfer 对象 | |
DataTransfer 对象是在拖放操作中用于传递数据的对象。它提供了一种机制，让你可以在拖放源和目标区域之间传递数据。 |
DataTransfer 对象包含了被拖动的数据，可以通过拖动事件中的 dataTransfer 属性来访问。它具有以下常用方法和属性：
其中format 是数据的格式，可以是 MIME 类型或自定义字符串。data 是要传递的数据。
| 属性和方法 | 描述 |
|---|---|
setData(format, data) |
设置指定格式的数据。 |
getData(format) |
获取指定格式的数据。 |
clearData([format]) |
清除指定格式的数据。 |
effectAllowed |
设置或获取拖放操作的可接受行为，取值："none"， "copy"， "move"， "link"， "copyLink"， "copyMove"， "linkMove"， "all"。 |
dropEffect |
设置或获取目标区域的处理拖放操作的方式。取值： "none"， "copy"， "move"， "link"， "copyLink"， "copyMove"， "linkMove"， "all"。 |
其中DataTransfer 对象支持以下数据类型：
| 数据类型 | 解析 |
|---|---|
| text/plain | 纯文本 |
| text/html | HTML文档 |
| text/uri-list | URL列表 |
| text/rtf | 富文本 |
| text/csv | CSV格式 |
| text/xml | XML文档 |
| text/javascript | JavaScript代码 |
| application/json | JSON数据 |
| image/* | 图片 |
| audio/* | 音频 |
| video/* | 视频 |
举个栗子?
有一个简单的拖拽场景，其中有一个可拖拽的元素和一个接受拖放的目标区域。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>drag API</title>
<style type="text/css">
#drag-source {
width: 100px;
height: 100px;
background-color: #f2f2f2;
border: 1px solid #ccc;
text-align: center;
line-height: 100px;
cursor: move;
}
#drop-target {
width: 400px;
height: 400px;
background-color: #ddd;
border: 1px dashed #666;
text-align: center;
line-height: 400px;
}
</style>
</head>
<body>
<div id="drag-source" draggable="true">拖拽我</div>
<div id="drop-target">放置到这里</div>
</body>
</html>
当拖拽源元素被拖拽时，使用 setData 方法将文本数据存储到 dataTransfer 对象中。
在目标区域的 dragover 事件中使用 preventDefault 方法阻止默认行为，以允许在该区域进行拖放操作。
在 drop 事件中，使用 getData 方法从 dataTransfer 对象中获取拖拽的文本数据，并将其显示在目标区域中。
<script>
const dragSource = document.getElementById("drag-source");
const dropTarget = document.getElementById("drop-target");
// 拖拽开始时设置数据
dragSource.addEventListener("dragstart", (event) => {
const dataTransfer = event.dataTransfer;
dataTransfer.setData("text/plain", "这是拖拽的文本数据");
});
// 目标区域接受拖放
dropTarget.addEventListener("dragover", (event) => {
event.preventDefault();
dropTarget.innerText = `拖拽源已到达目标区域`;
});
// 在目标区域放置拖拽数据
dropTarget.addEventListener("drop", (event) => {
event.preventDefault();
const dataTransfer = event.dataTransfer;
const draggedData = dataTransfer.getData("text/plain");
// 在目标区域显示拖拽的数据
dropTarget.innerText = `接受到的数据：${draggedData}`;
});
</script>
跨窗口或跨文档的拖拽操作
跨窗口或跨文档的拖拽操作是指在不同的窗口或文档之间进行拖拽操作。这种情况下，我们需要处理不同窗口或文档之间的通信和数据传输。
我们在源窗口或文档中设置了一个可拖拽的元素，当开始拖拽时，将数据和效果设置到 DataTransfer 对象中
<body>
<div id="drag-source" draggable="true">拖拽我</div>
<script>
// 在源窗口或文档中
var dragSource = document.getElementById("drag-source");
dragSource.addEventListener("dragstart", function (event) {
event.dataTransfer.setData("text/plain", "Hello, World!");
event.dataTransfer.effectAllowed = "copy";
});
</script>
</body>
在目标窗口或文档中，监听 dragover 和 drop 事件，并阻止默认行为。在 drop 事件处理程序中，从 DataTransfer 对象中获取数据，将数据显示在目标区域上。
<body>
<!-- 目标窗口或文档 -->
<div id="drop-target">放置区域</div>
<script>
// 在目标窗口或文档中
var dropTarget = document.getElementById("drop-target");
dropTarget.addEventListener("dragover", function (event) {
event.preventDefault();
});
dropTarget.addEventListener("drop", function (event) {
event.preventDefault();
var data = event.dataTransfer.getData("text/plain");
dropTarget.innerText = data
console.log("拖拽数据:", data);
});
</script>
</body>
拖拽事件在不同的浏览器中可能存在差异，特别是在旧版本的浏览器中。因此，在使用拖拽事件时，需要进行浏览器兼容性测试，并提供替代方案或降级策略，以确保在不同浏览器下都能正常工作。
案例分析 – 图片拖拽排序
拖拽事件可以涵盖多个领域，下面几个是常见的示例：
- 图片拖拽排序：在一个图片集合中，用户可以通过拖拽图片来改变它们的顺序。这可以应用于相册、画廊等场景中，提供更直观的图片排序方式。
- 文件上传拖拽：在文件上传功能中，可以使用拖拽事件将文件拖拽到指定区域，实现快速的文件上传操作。
- 可视化数据操作：在数据可视化应用中，可以利用拖拽事件实现交互式的数据操作，例如拖拽图表元素改变其位置或大小，拖拽数据点进行数据筛选或排序等，增强用户对数据的探索和操作能力。
下面举一个照片拖拽的例子，通过拖拽照片来实现他们的重新排序
我们创建了一个包含多张照片的容器photo-container。每张照片都有draggable属性设置为true，表示它们可拖拽。
<div id="photo-container">
<img src="photo-1.jpg" draggable="true">
<img src="photo-2.jpg" draggable="true">
<img src="photo-3.jpg" draggable="true">
<img src="photo-4.jpg" draggable="true">
</div>
获取照片容器photo-container和所有的照片元素。然后，我们为每张照片添加了三个拖拽事件的监听器：dragstart、dragover和drop。
// 获取照片容器和照片元素
const photoContainer = document.getElementById("photo-container");
const photos = photoContainer.querySelectorAll("img");
// 监听拖拽事件
photos.forEach((photo) => {
photo.addEventListener("dragstart", handleDragStart);
photo.addEventListener("dragover", handleDragOver);
photo.addEventListener("drop", handleDrop);
});
然后再写出对应的拖拽事件函数
// 记录拖拽的照片元素
let draggedPhoto = null;
// 拖拽开始时保存被拖拽的照片元素
function handleDragStart(event) {
draggedPhoto = event.target;
}
// 阻止默认的拖拽行为
function handleDragOver(event) {
event.preventDefault();
}
// 处理照片放置的位置
function handleDrop(event) {
event.preventDefault();
// 将被拖拽的照片插入到目标位置之前
const dropTarget = event.target;
const parentContainer = dropTarget.parentElement;
parentContainer.insertBefore(draggedPhoto, dropTarget);
}
以上、我们就实现了一个简单的照片拖拽排序功能。用户可以通过拖拽照片来改变它们的顺序。
总结
在现代的 Web 应用中，拖拽操作已成为一种常见的用户交互方式，它为用户提供了直观而灵活的操作体验。通过拖拽，用户可以轻松地移动、排序、组织或交互元素，从而实现自定义布局、拖拽上传、图像排序等功能。
但是drag api也是有一定的局限性的。Drag API 在不同浏览器之间的支持程度有所差异，某些浏览器可能不支持或存在兼容性问题。在移动设备上，拖拽操作可能不如在桌面设备上流畅，因为移动设备上的触摸事件与鼠标事件有所不同。
尽管 Drag API 具有一些局限性，但在适当的场景下，它仍然是一种有用的工具，可以为用户提供良好的交互体验，并且能够实现一些复杂的界面效果。在使用 Drag API 时，需要权衡其优势和局限性，并根据具体的需求来选择合适的方案。
