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

linshuai發表於2017-05-02

前言

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 屬性

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

值得注意的是:dataTransfer 物件不支援IE。對,不支援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.parentNode.insertBefore(dragElement,this);
        }
    }, false)

    source[i].addEventListener('dragleave', function(ev){
        if(dragElement != this){
            if(this == this.parentNode.lastElementChild || this == this.parentNode.lastChild){
                this.parentNode.appendChild(dragElement);
            }
        }
    }, false)
};

document.ondragover = function(e){e.preventDefault();}
document.ondrop = function(e){e.preventDefault();}複製程式碼

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

相容

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

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

更重要的一點是在 ios 和安卓上,完全不相容。不過還好,有一個外掛能讓它在移動端完美相容。
外掛地址:ios-html5-drag-drop-shim

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

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

更多文章:lin-xin/blog

微信讚賞

HTML5 進階系列:拖放 API 實現拖放排序
謝謝支援

相關文章