拖放是網頁上再常見不過的互動:抓住一個物件,拖到想放的位置。過去我們得靠 jQuery UI 這類函式庫的 draggable、droppable 元件來硬湊,而在 HTML5 中,拖放成為標準操作,任何元素都能支援。也因為需求實在太普遍,主流瀏覽器無一例外都實作了它。
簡單到令人意外——只要把元素的 draggable 屬性打開:
<img draggable="true" />
實務上,拖放往往需要伴隨邏輯資料的傳遞,這裡的主角是 dataTransfer 物件。
setData(format, data):把被拖動的資料寫入 dataTransfer。
getData(format):取出 dataTransfer 中存放的拖動資料,format 含義同 setData。
clearData(format):移除指定類型的資料。除了 "Text" 與 "URL",format 還可取 file(檔案)、html(HTML 元素)、image(圖片),可用於選擇性清理資料類型。
effectAllowed:設定或取得「資料來源元素」允許執行的操作,字串可取值如下:
把 effectAllowed 設為 none 之後拖動確實被禁止,但滑鼠游標仍會顯示「不可放置」的形狀。若不想看到這個游標,需要把 window event 的 returnValue 設為 false。
dropEffect:設定或取得放置目標允許的操作,同時決定相應的滑鼠形狀。
分工上:effectAllowed 描述資料來源支持什麼,通常在 ondragstart 中設定;dropEffect 描述放置目標支持什麼,因此常與 effectAllowed 搭配,出現在目標元素的 ondragenter、ondragover、ondrop 等事件中。
另外兩個屬性:files 回傳被拖動檔案的 FileList;types 是 ondragstart 時送出的資料類型清單。
總結來說:在資料源的 ondragstart 中用 setData 提供資料,在目標元素中用 getData 取出,兩端就打通了。
觸發順序大致如下:
事件參數 event 都會帶入相關元素,操作起來相當方便。實務上不必每個事件都掛,通常處理幾個關鍵環節即可。
這個事件的參數資訊很豐富:可取得被拖動元素(event.target),可設定被拖動資料(event.dataTransfer.setData),足以支撐拖放背後的完整邏輯。
ondrag 的對象是被拖拽元素,通常處理得較少。ondragenter 在拖入當前元素時發生,ondragleave 在拖離時發生,ondragover 在元素內移動時發生。
這裡有一個關鍵陷阱:瀏覽器預設禁止 drop。要讓元素可以接收放置,必須在該處理函式中回傳 false 或呼叫 event.preventDefault()。
資料被成功 drop 時觸發 drop 事件,之後觸發 dragend,後者實際使用頻率相對較低。
<!DOCTYPE Html>
<Html>
<head>
<script type="text/Javascript">
function allowDrop(ev){ ev.preventDefault(); }
function drag(ev){ ev.dataTransfer.setData("Text", ev.target.id); }
function drop(ev){
var data = ev.dataTransfer.getData("Text");
ev.target.appendChild(document.getElementById(data));
ev.preventDefault();
}
</script>
</head>
<body>
<div id="div1" ondrop="drop(event)" ondragover="allowDrop(event)"></div>
<img id="drag1" src="img_logo.gif" draggable="true" ondragstart="drag(event)" width="336" height="69" />
</body>
</Html>
更有趣的應用是:把本地圖片直接拖進網頁,頁面立刻顯示出來。這個效果用到了 dataTransfer 的 files 屬性。
<!DOCTYPE Html>
<Html>
<head>
<meta charset="utf-8">
<title>HTML5 拖放文件</title>
<style>
#section { font-family:"Georgia","微軟雅黑","華文中宋"; }
.container {
display:inline-block; min-height:200px; min-width:360px;
color:#f30; padding:30px; border:3px solid #ddd;
-moz-border-radius:10px; -webkit-border-radius:10px; border-radius:10px;
}
.preview { max-width:360px; }
#files-list { position:absolute; top:0; left:500px; }
#list { width:460px; }
#list.preview { max-width:250px; }
#list p { color:#888; font-size:12px; }
</style>
</head>
<body>
<div id="section">
<p>把你的圖片拖到下面的容器內:</p>
<div id="container" class="container"></div>
<div id="files-list">
<p>已經拖進過來的文件:</p>
<ul id="list"></ul>
</div>
</div>
<script>
if (window.FileReader) {
var list = document.getElementById('list'),
cnt = document.getElementById('container');
// 判斷是否為圖片
function isImage(type) {
switch (type) {
case 'image/jpeg': case 'image/png': case 'image/gif':
case 'image/bmp': case 'image/jpg': return true;
default: return false;
}
}
// 處理拖放進來的文件清單
function handleFileSelect(evt) {
evt.stopPropagation();
evt.preventDefault();
var files = evt.dataTransfer.files;
for (var i = 0, f; f = files[i]; i++) {
var t = f.type ? f.type : 'n/a',
reader = new FileReader(),
isImg = isImage(t), img;
var looks = function(f, img) {
list.innerHTML += '<li><strong>' + f.name + '</strong> (' + t +
') - ' + f.size + ' bytes<p>' + img + '</p></li>';
cnt.innerHTML = img;
};
if (isImg) {
reader.onload = (function(theFile){
return function(e) {
img = '<img class="preview" src="' + e.target.result +
'" title="' + theFile.name + '" />';
looks(theFile, img);
};
})(f);
reader.readAsDataURL(f);
} else {
looks(f, '你傳進來的不是圖片!!');
}
}
}
function handleDragEnter(evt){ this.setAttribute('style','border-style:dashed;'); }
function handleDragLeave(evt){ this.setAttribute('style',''); }
// 阻止瀏覽器預設行為導致的頁面跳轉
function handleDragOver(evt){ evt.stopPropagation(); evt.preventDefault(); }
cnt.addEventListener('dragenter', handleDragEnter, false);
cnt.addEventListener('dragover', handleDragOver, false);
cnt.addEventListener('drop', handleFileSelect, false);
cnt.addEventListener('dragleave', handleDragLeave, false);
} else {
document.getElementById('section').innerHTML = '你的瀏覽器不支援,同學';
}
</script>
</body>
</Html>
這個例子用到了 HTML5 的檔案讀取 API:FileReader 物件,它提供了幾個異步讀取方法:
讀取過程會觸發下列事件:onloadstart、onprogress、onabort、onerror、onload、onloadend。需要時掛上即可:
function startRead(){
var file = document.getElementById('file').files[0];
if (file) { getAsText(file); }
}
function getAsText(readFile){
var reader = new FileReader();
reader.readAsText(readFile, "UTF-16");
reader.onprogress = updateProgress;
reader.onload = loaded;
reader.onerror = errorHandler;
}
function updateProgress(evt){
if (evt.lengthComputable) {
var loaded = (evt.loaded / evt.total);
if (loaded < 1) {
// 可在此更新進度條寬度
}
}
}
function loaded(evt){
var fileString = evt.target.result;
// 在這裡處理讀到的內容
}
function errorHandler(evt){
if (evt.target.error.name == "NotReadableError") {
// 檔案無法讀取
}
}
補充一個對照:最樸素的檔案下載寫法就是 window.open,例如:
window.open('https://aaa.bbbb.com/ccc.rar', '_blank')