「拖動排序」顧名思義,就是按住一行資料把它拖到想要的位置,放開後即保存新的排序。這在後台管理清單、待辦事項等場景非常實用。本文完整拆解實作思路,並給出可封裝成外掛的完整程式碼。
做法是:為每一列建立一個可拖曳的錨點,綁定 mousedown 與 mouseup 事件。按下時記錄起始資訊,拖動時計算位移並判斷目標位置,放開時把該列移到目標處,再對受影響的所有列重新排序並回傳後端。
看似簡單,仍有幾個關鍵細節要處理:移動到哪個位置算插入目標列、移出頂端或底端時如何判斷為第一或最後、以及向上與向下移動要用不同的插入方式。
原生 JavaScript 的滑鼠事件是 onmousedown、onmouseup,在 jQuery 中則寫作 mousedown、mouseup,因此這裡採用後者。
首先得知道有多少列、每列多高,才能判斷滑鼠移動的距離:
var tbodyHeight = setting.frame.outerHeight(); // 父對象高度
var lineNum = $("." + setting.dgLine).length; // 行數
var lineHeight = Math.ceil(tbodyHeight / lineNum); // 每列高度
取行數除了算行高,也是為了搭配 index(),用序列索引把目標列移到指定位置。
mousedown 觸發後,記錄移動列的 ID、索引、top 值,以及它到頂端與底端的距離:
dgid = $(this).attr(setting.id); // 移動行的唯一標識 ID
thisIndex = $("#" + setting.linePre + dgid).index(); // 該行索引
thisLineTop = $("#" + setting.linePre + dgid).offset().top; // 該行 top 值
topDistance = thisIndex * lineHeight; // 距離頂端的距離
downDistance = (lineNum - thisIndex - 1) * lineHeight; // 距離底端的距離
dgid 用來區分每一列(一般列表由程式循環輸出,若無唯一 ID 便無法辨識),thisLineTop 則兼作「是否按在錨點上」的判斷依據,避免在頁面任意處點擊都誤觸 mouseup。
$("#" + setting.linePre + dgid).css('background', setting.lineHighlight); // 高亮移動行
$('body').css('cursor', 'move'); // 更改游標手勢
setting.frame.mousemove(function(e){ // 讓提示層跟隨滑鼠
$("#dgf").css({"left": e.pageX + setting.tipsOffsetLeft + 'px', "top": e.pageY + 'px'});
});
若沒有用 jQuery UI,可用純 CSS 達成「禁止選取」的效果:
$('body').each(function() {
$(this).attr('unselectable', 'on').css({
'-moz-user-select': 'none',
'-webkit-user-select': 'none',
'user-select': 'none'
}).each(function() {
this.onselectstart = function() { return false; };
});
});
為避免滑鼠移出錨點後 mouseup 失效,建議把它綁在 body 上。觸發後先確認 thisLineTop 有值,再判斷位移正負決定向上或向下:
var moveDistance = e.pageY - thisLineTop;
if(moveDistance < 0){ // 向上移動
if(thisIndex != 0){
moveDistance = Math.abs(moveDistance);
if(moveDistance > lineHeight / 2){ // 超過半行才算移動
if(moveDistance > topDistance){ focusIndex = 0; }
else{ focusIndex = thisIndex - Math.ceil(moveDistance / lineHeight); }
$("." + setting.dgLine).eq(focusIndex).before($("#" + setting.linePre + dgid));
}
}
} else { // 向下移動
if(thisIndex != lineNum - 1){
if(moveDistance > lineHeight / 2 + lineHeight){
if(moveDistance > downDistance){ focusIndex = lineNum - 1; }
else{ focusIndex = thisIndex + Math.ceil(moveDistance / lineHeight) - 1; }
$("." + setting.dgLine).eq(focusIndex).after($("#" + setting.linePre + dgid));
}
}
}
之所以用「半行高」作門檻,是為了忽略細微抖動;向上用 before、向下用 after,則是為了正確插入到目標列的相對位置。移動完成後別忘了清除提示層、取消高亮、還原游標。
把上述邏輯收攏進 $.fn.DragList,並在放開後以 $.getJSON 把受影響範圍的新順序回傳後端保存,就得到一個可重複使用的排序外掛。使用時只要給定容器與列樣式即可:
$("#drag_table").DragList({
dgLine: 'drag_line', // 列的 class
dgButton: 'drag_orders', // 拖曳錨點的 class
id: 'action-id', // 列的唯一標識屬性
linePre: 'list_', // 列 ID 前綴
JSONUrl: '...', // 保存排序的後端位址
maskLoadIcon: '...loading.gif' // 保存時的遮罩載入圖
});
整個功能的難點集中在「移動判斷」與「插入位置計算」上,其餘多為提升體驗的點綴。把效果打磨得更細緻、提示更清楚,用戶的拖曳體驗就會更順手。