HTML5 進階系列：拖放 API 實現拖放排序

2019 年 12 月 4 日
筆記

前言

HTML5 中提供了直接拖放的 API，極大的方便我們實現拖放效果，不需要去寫一大堆的 js，只需要通過監聽元素的拖放事件就能實現各種拖放功能。

想要拖放某個元素，必須設置該元素的 draggable 屬性為 true，當該屬性為 false 時，將不允許拖放。而 img 元素和 a 元素都默認設置了 draggable 屬性為 true，可直接拖放，如果不想拖放這兩個元素，把屬性設為 false 即可。

拖放事件

拖放事件由不同的元素產生。一個元素被拖放，他可能會經過很多個元素上，最終到達想要放置的元素內。這裡，我暫時把被拖放的元素稱為源對象，被經過的元素稱為過程對象，到達的元素我稱為目標對象。不同的對象產生不同的拖放事件。

源對象：

dragstart：源對象開始拖放。
drag：源對象拖放過程中。
dragend：源對象拖放結束。

過程對象：

dragenter：源對象開始進入過程對象範圍內。
dragover：源對象在過程對象範圍內移動。
dragleave：源對象離開過程對象的範圍。

目標對象：

drop：源對象被拖放到目標對象內。

<div id="source" draggable="true">a元素</div>  <div id="process">b元素</div>  <div id="target">c元素</div>    <script>      var source = document.getElementById('source'),     // a元素          process = document.getElementById('process'),   // b元素          target = document.getElementById('target');     // c元素        source.addEventListener('dragstart',function(ev){   // dragstart事件由a元素產生          console.log('a元素開始被拖動');      },false)        process.addEventListener('dragenter',function(ev){  // dragenter事件由b元素產生          console.log('a元素開始進入b元素');      },false)      process.addEventListener('dragleave',function(ev){  // dragleave事件由b元素產生          console.log('a元素離開b元素');      },false)        target.addEventListener('drop',function(ev){        // drop事件由c元素產生          console.log('a元素拖放到c元素了');          ev.preventDefault();      },false)      document.ondragover = function(e){e.preventDefault();}  </script>

dataTransfer 對象

在所有拖放事件中提供了一個數據傳遞對象 dataTransfer，用於在源對象和目標對象間傳遞數據。接下來認識一下這個對象的方法和屬性，來了解它是如何傳遞數據的。

setData()

該方法向 dataTransfer 對象中存入數據。接收兩個參數，第一個表示要存入數據種類的字元串，現在支援有以下幾種：

text/plain：文本文字。
text/html：HTML文字。
text/xml：XML文字。
text/uri-list：URL列表，每個URL為一行。

第二個參數為要存入的數據。例如：

event.dataTransfer.setData('text/plain','Hello World');

getData()

該方法從 dataTransfer 對象中讀取數據。參數為在 setData 中指定的數據種類。例如：

event.dataTransfer.getData('text/plain');

clearData()

該方法清除 dataTransfer 對象中存放的數據。參數可選，為數據種類。若參數為空，則清空所有種類的數據。例如：

event.dataTransfer.clearData();

setDragImage()

該方法通過用img元素來設置拖放圖標。接收三個參數，第一個為圖標元素，第二個為圖標元素離滑鼠指針的X軸位移量，第三個為圖標元素離滑鼠指針的Y軸位移量。例如：

var source = document.getElementById('source'),      icon = document.createElement('img');    icon.src = 'img.png';    source.addEventListener('dragstart',function(ev){      ev.dataTransfer.setDragImage(icon,-10,-10)  },false)

effectAllowed 和 dropEffect 屬性

這兩個屬性結合起來設置拖放的視覺效果。

值得注意的是：IE 不支援 dataTransfer 對象。對，不管哪個 IE 版本都不支援。

實現拖放排序

上面已經熟悉了拖放 API 的使用，我們來實現個簡單的拖放排序，這也是在項目中比較常見的。先來理一下思路：

在一個列表中，每個元素都可以被拖放，那首先要給每個元素設置 draggable 屬性為 true。
監聽每個元素的 dragstart 事件，對源對象做樣式處理來區分。
監聽每個元素的 dragenter 事件，當源對象進入到當前元素里，就把源對象添加到該元素之前。這樣子後面的元素就會被源對象擠下去了，實現了排序的效果。
但是會發現，源對象無法排到最後一個去，只能在倒數第二。這時就要監聽 dragleave 事件，當過程對象是最後一個元素時，源對象離開了過程對象，這時就把源對象添加到最後去。

主要程式碼如下：

var source = document.querySelectorAll('.list'),      dragElement = null;    for(var i = 0; i < source.length; i++){      source[i].addEventListener('dragstart',function(ev){          dragElement = this;      },false);        source[i].addEventListener('dragenter', function(ev){          if(dragElement != this){              this.insertBefore(dragElement,this);          }      }, false)        source[i].addEventListener('dragleave', function(ev){          if(dragElement != this){              if(this == this.lastElementChild || this == this.lastChild){                  this.appendChild(dragElement);              }          }      }, false)  };    document.ondragover = function(e){e.preventDefault();}  document.ondrop = function(e){e.preventDefault();}

完整的程式碼地址：drag-demo

兼容

主要是在IE中的兼容不太好，不過至少在IE10中能兼容上面的拖動排序。

而且在我簡單的試驗中發現，就是在 IE 中元素不設置 height 的時候，不會觸發 dragleave 事件。

更重要的一點是在 ios 和Android上，完全不兼容。不過還好，有一個插件能讓它在移動端完美兼容。插件地址：ios-html5-drag-drop-shim

只需要在原有的程式碼中引入該插件，即可在移動端上實現拖動了。

<script>  var iosDragDropShim = { enableEnterLeave: true }  </script>  <script src="vendor/ios-drag-drop.js"></script>