基于JavaScript 实现拖放功能

程序员文章站 2023-10-14 12:58:35

html 的拖放 api 依赖 dom 事件模型，获取拖放和放置元素的相关信息，以此实现拖放功能。我们只需要注册很少几个事件监听器，就能把任何元素变成可拖动或可放置的。...

html 的拖放 api 依赖 dom 事件模型，获取拖放和放置元素的相关信息，以此实现拖放功能。我们只需要注册很少几个事件监听器，就能把任何元素变成可拖动或可放置的。

拖放 api 除了提供基本的拖放功能接口外，还可以在拖放之外提供选择，用来自定义行为。比如，可以修改拖放元素的 css 样式。或者，我们不移动元素，拖动的时候，复制一个副本，拖放结束后，我们就会多了一个同样的元素。

本篇只介绍实现基本的拖放功能。

将元素设置成可拖动的

我们先从拖动元素开始。假设我们有一个容器元素，其中包含两种类型的子元素：可拖动元素和可放置元素。举个例子，如果我们有一个待办事项列表，我们可以将待办事项拖到“完成”区域。

简单起见，我们将移动的元素称为拖动元素，将拖动元素移入的目标元素称为 dropzone。

<div class='parent'>
 <span id='draggablespan'>
  draggable
 </span>
 <span> dropzone </span>
</div>

基于JavaScript 实现拖放功能

这是我们的第一段代码，子元素现在还不能拖动。

下面给拖动元素添加属性 draggable='true' ，将它设置成一个可拖动元素。

<div class='parent'>
 <span id='draggablespan' draggable='true'>
  draggable
 </span>
 <span> dropzone </span>
</div>

现在你再用鼠标拖动拖动元素的时候，它就会跟随鼠标移动（对不起，移动端不行:see_no_evil:）。

draggable 属性在没设置的情况下，默认值 auto 。就是说，元素是可不可以拖动，取决于浏览器的默认设置。比如，链接（ <a> ）默认就是可拖动的，而 <span> 就不是。

拖放事件处理器

到目前为止，如果我们拖动元素，释放鼠标，什么事都不会发生。拖动和放置都会触发事件，实现一个基本的拖放功能，我们最少需要用到拖放 api 中的三个事件：

ondragstart
ondragover
ondrop

学会使用 ondragstart 、 ondragover 、 ondrop 事件只是个开始。拖拽过程一共会涉及八个事件： ondrag 、 ondragend 、 ondragenter 、 ondragexit 、 ondragleave 、 ondragover 、 ondragstart 和 ondrop 。

datatransfer

datatransfer 接口中保存了与当前拖放过程相关的跟踪信息，信息从 datatransfer 对象属性中获得，而 datatransfer 对象又是从 dom 事件对象中获得的。

技术上讲， datatransfer 接口可以同时跟踪多个拖动对象的信息，我们这里只关注拖动一个元素的情况。:sparkles:

拖动时更新元素

下一步，我们开始设置 ondragstart 的事件处理器。

拖动开始时，我们可以在 ondragstart 处理器中，做任何想做的修改。比如更新拖动元素的 css 样式，将拖动的版本设置为临时图片，或者其他能从 dom 事件中访问到的任何内容。

datatransfer 对象的 setdata 属性可以用来设置拖动状态信息。它接收两个参数，第一个参数是表示内容格式的字符串，第二个参数是实际传递的数据。

我们要实现的功能是将拖动元素移动到一个新的父元素里面。我们需要获取拖动元素，因此需要将拖动元素的 id 通过 setdata 属性保存下来：

function ondragstart(event) {
 event
  .datatransfer
  .setdata('text/plain', event.target.id);
}

再从事件对象中获得拖动元素并设置 css 样式：

function ondragstart(event) {
 event
  .datatransfer
  .setdata('text/plain', event.target.id);

 event
  .currenttarget
  .style
  .backgroundcolor = 'yellow';
}

注意：如果上面的黄色背景样式，你只希望在拖动时才应用，那么拖动结束后，就要手动将样式恢复。就会说，拖动开始时，如果修改了元素样式，除非再次修改过来，否则样式是不会自动恢复的。:rainbow:

拖动开始时的处理函数写好了，现在将它设置给可拖动元素的 ondragstart 属性：

<div class='parent'>
 <span id='draggablespan'
  draggable='true'
  ondragstart='ondragstart(event);'>
   draggable
 </span>

 <span> dropzone </span>
</div>

下面是使用鼠标拖动时的效果：

现在拖动元素， ondragstart 中的代码就会执行，样式改变了，但释放拖动元素后，什么事情都没发生。接下来我们将视线转移到 dropzone 上来。

设置元素为可放置的

ondragstart 之后，下一个要写的处理函数就是 ondragover 了。上面讲过，放置行为默认是被浏览器阻止的，我们需要取消这个默认行为，双重否定为肯定，对吧？

function ondragover(event) {
 event.preventdefault();
}

在阻止浏览器干扰后，现在就能将拖动元素添加到 dropzone 了，dropzone 成为能够接受任何拖动元素的容器元素。

<div class='parent'>
 <span id='draggablespan'
  draggable='true'
  ondragstart='ondragstart(event);'>
   draggable
 </span>

 <span ondragover='ondragover(event);'>
  dropzone
 </span>
</div>

即便现在 dropzone 可以接受拖动元素，释放鼠标后还是看不见改变发生。

放置的时候要做什么？

现在要介绍第三个也是最后一个处理函数 ondrop 。

我们的函数逻辑遵循以下步骤：

还记得在 setdata 中设置的数据吗？
现在我们需要从 datatransfer 对象的 getdata 属性中获取设置的数据，数据内容是拖动元素的 id，它会返回给我们。
使用上一步获取的 id，获得拖动元素。获取 dropzone 元素。
将拖拽元素 append 到 dropzone 中。
清理 datatransfer 对象中保存的数据。

function ondrop(event) {
 const id = event
  .datatransfer
  .getdata('text');

 const draggableelement = document.getelementbyid(id);
 const dropzone = event.target;
 
 dropzone.appendchild(draggableelement);

 event
  .datatransfer
  .cleardata();
}

因为这是我们要写的第三个也是最后一个函数，我们只要将它传递给 dropzone 的 ondrop 属性，就完成了一个完整的拖放功能！

<div class='parent'>
 <span id='draggablespan'
  draggable='true'
  ondragstart='ondragstart(event);'>
   draggable
 </span>

 <span
  ondragover='ondragover(event);'
  ondrop='ondrop(event);'>
   dropzone
 </span>
</div>