前言
HTML5 中提供了直接拖放的 API普办,極大的方便我們實(shí)現(xiàn)拖放效果棒仍,不需要去寫一大堆的 js捉兴,只需要通過監(jiān)聽元素的拖放事件就能實(shí)現(xiàn)各種拖放功能藕畔。
想要拖放某個(gè)元素马僻,必須設(shè)置該元素的 draggable 屬性為 true,當(dāng)該屬性為 false 時(shí)注服,將不允許拖放韭邓。而 img 元素和 a 元素都默認(rèn)設(shè)置了 draggable 屬性為 true,可直接拖放溶弟,如果不想拖放這兩個(gè)元素女淑,把屬性設(shè)為 false 即可。
拖放事件
拖放事件由不同的元素產(chǎn)生可很。一個(gè)元素被拖放诗力,他可能會(huì)經(jīng)過很多個(gè)元素上凰浮,最終到達(dá)想要放置的元素內(nèi)我抠。這里,我暫時(shí)把被拖放的元素稱為源對(duì)象袜茧,被經(jīng)過的元素稱為過程對(duì)象菜拓,到達(dá)的元素我稱為目標(biāo)對(duì)象。不同的對(duì)象產(chǎn)生不同的拖放事件笛厦。
源對(duì)象:
- dragstart:源對(duì)象開始拖放纳鼎。
- drag:源對(duì)象拖放過程中。
- dragend:源對(duì)象拖放結(jié)束。
過程對(duì)象:
- dragenter:源對(duì)象開始進(jìn)入過程對(duì)象范圍內(nèi)贱鄙。
- dragover:源對(duì)象在過程對(duì)象范圍內(nèi)移動(dòng)劝贸。
- dragleave:源對(duì)象離開過程對(duì)象的范圍。
目標(biāo)對(duì)象:
- drop:源對(duì)象被拖放到目標(biāo)對(duì)象內(nèi)逗宁。
<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元素產(chǎn)生
console.log('a元素開始被拖動(dòng)');
},false)
process.addEventListener('dragenter',function(ev){ // dragenter事件由b元素產(chǎn)生
console.log('a元素開始進(jìn)入b元素');
},false)
process.addEventListener('dragleave',function(ev){ // dragleave事件由b元素產(chǎn)生
console.log('a元素離開b元素');
},false)
target.addEventListener('drop',function(ev){ // drop事件由c元素產(chǎn)生
console.log('a元素拖放到c元素了');
ev.preventDefault();
},false)
document.ondragover = function(e){e.preventDefault();}
</script>
dataTransfer 對(duì)象
在所有拖放事件中提供了一個(gè)數(shù)據(jù)傳遞對(duì)象 dataTransfer映九,用于在源對(duì)象和目標(biāo)對(duì)象間傳遞數(shù)據(jù)。接下來(lái)認(rèn)識(shí)一下這個(gè)對(duì)象的方法和屬性瞎颗,來(lái)了解它是如何傳遞數(shù)據(jù)的件甥。
setData()
該方法向 dataTransfer 對(duì)象中存入數(shù)據(jù)。接收兩個(gè)參數(shù)哼拔,第一個(gè)表示要存入數(shù)據(jù)種類的字符串引有,現(xiàn)在支持有以下幾種:
- text/plain:文本文字。
- text/html:HTML文字倦逐。
- text/xml:XML文字譬正。
- text/uri-list:URL列表,每個(gè)URL為一行僻孝。
第二個(gè)參數(shù)為要存入的數(shù)據(jù)导帝。例如:
event.dataTransfer.setData('text/plain','Hello World');
getData()
該方法從 dataTransfer 對(duì)象中讀取數(shù)據(jù)。參數(shù)為在 setData 中指定的數(shù)據(jù)種類穿铆。例如:
event.dataTransfer.getData('text/plain');
clearData()
該方法清除 dataTransfer 對(duì)象中存放的數(shù)據(jù)您单。參數(shù)可選,為數(shù)據(jù)種類荞雏。若參數(shù)為空虐秦,則清空所有種類的數(shù)據(jù)。例如:
event.dataTransfer.clearData();
setDragImage()
該方法通過用img元素來(lái)設(shè)置拖放圖標(biāo)凤优。接收三個(gè)參數(shù)悦陋,第一個(gè)為圖標(biāo)元素,第二個(gè)為圖標(biāo)元素離鼠標(biāo)指針的X軸位移量筑辨,第三個(gè)為圖標(biāo)元素離鼠標(biāo)指針的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 屬性
這兩個(gè)屬性結(jié)合起來(lái)設(shè)置拖放的視覺效果。
值得注意的是:dataTransfer 對(duì)象不支持IE棍辕。對(duì)暮现,不支持IE。
實(shí)現(xiàn)拖放排序
上面已經(jīng)熟悉了拖放 API 的使用楚昭,我們來(lái)實(shí)現(xiàn)個(gè)簡(jiǎn)單的拖放排序栖袋,這也是在項(xiàng)目中比較常見的。先來(lái)理一下思路:
- 在一個(gè)列表中抚太,每個(gè)元素都可以被拖放塘幅,那首先要給每個(gè)元素設(shè)置 draggable 屬性為 true昔案。
- 監(jiān)聽每個(gè)元素的 dragstart 事件,對(duì)源對(duì)象做樣式處理來(lái)區(qū)分电媳。
- 監(jiān)聽每個(gè)元素的 dragenter 事件踏揣,當(dāng)源對(duì)象進(jìn)入到當(dāng)前元素里,就把源對(duì)象添加到該元素之前匾乓。這樣子后面的元素就會(huì)被源對(duì)象擠下去了呼伸,實(shí)現(xiàn)了排序的效果。
- 但是會(huì)發(fā)現(xiàn)钝尸,源對(duì)象無(wú)法排到最后一個(gè)去括享,只能在倒數(shù)第二。這時(shí)就要監(jiān)聽 dragleave 事件珍促,當(dāng)過程對(duì)象是最后一個(gè)元素時(shí)铃辖,源對(duì)象離開了過程對(duì)象,這時(shí)就把源對(duì)象添加到最后去猪叙。
主要代碼如下:
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中能兼容上面的拖動(dòng)排序。
而且在我簡(jiǎn)單的試驗(yàn)中發(fā)現(xiàn)穴翩,就是在 IE 中元素不設(shè)置 height 的時(shí)候犬第,不會(huì)觸發(fā) dragleave 事件。
更重要的一點(diǎn)是在 ios 和安卓上芒帕,完全不兼容歉嗓。不過還好,有一個(gè)插件能讓它在移動(dòng)端完美兼容背蟆。
插件地址:ios-html5-drag-drop-shim
只需要在原有的代碼中引入該插件鉴分,即可在移動(dòng)端上實(shí)現(xiàn)拖動(dòng)了。
<script>
var iosDragDropShim = { enableEnterLeave: true }
</script>
<script src="vendor/ios-drag-drop.js"></script>