「拖一下就能調整順序」是後台很常被要求的功能,例如排序首頁橫幅、調整側欄模組。要自己從零實作拖放,得處理滑鼠座標、碰撞偵測、拖曳中的視覺回饋、拖完之後的 DOM 搬移……工程量不小。實務上直接拿現成套件更快,這篇整理兩個我實際用過的方案。
方案一:dragsort
dragsort 的優點是輕、沒有 jQuery UI 的依賴、API 直觀,而且支援多組清單之間互相拖放。最簡單的用法只要一行:
. 代碼如下:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jQuery 列表拖曳排序示範</title>
<script type="text/javascript" src="js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="js/jquery.dragsort-0.4.min.js"></script>
<style type="text/css">
*{margin:0;padding:0;list-style-type:none;}
body{font-family:Arial;font-size:12pt;color:#333;}
.dragsort-ver li{height:30px;line-height:30px;}
.dragsort{width:350px;list-style-type:none;margin:0px;}
.dragsort li{float:left;padding:5px;width:100px;height:100px;}
.dragsort div{width:90px;height:50px;border:solid 1px black;background-color:#E0E0E0;text-align:center;padding-top:40px;}
.placeHolder div{background-color:white!important;border:dashed 1px gray!important;}
</style>
</head>
<body>
<ul class="dragsort-ver">
<li>你猜</li>
<li>你不猜</li>
<li>你不猜你不猜</li>
<li><input type="checkbox" name="intro_fields[]" value="猜猜"/>猜猜</li>
<li>你猜不猜</li>
</ul>
<script type="text/javascript">
$("ul:first").dragsort();
</script>
<ul class="dragsort" id="list2" style="float:right;">
<li><div>10</div></li>
<li><div>11</div></li>
</ul>
<ul class="dragsort" id="list1">
<li><div>1</div></li>
<li><div>2</div></li>
<li><div>3</div></li>
</ul>
<!-- 排序結果寫進這個隱藏欄位,方便送到伺服器 -->
<input name="list1SortOrder" type="hidden" />
<script type="text/javascript">
$("#list1, #list2").dragsort({
dragSelector: "div",
dragBetween: true,
dragEnd: saveOrder,
placeHolderTemplate: "<li class='placeHolder'><div></div></li>",
scrollSpeed: 5
});
function saveOrder() {
var data = $("#list1 li").map(function(){
return $(this).children().html();
}).get();
$("input[name=list1SortOrder]").val(data.join("|"));
};
</script>
</body>
</html>
dragsort 主要參數
dragSelector:拖曳把手的选择器,預設 li。實務上很建議只把某個「⠿ 拖曳圖示」設為把手,避免使用者誤觸。
dragSelectorExclude:排除清單,預設 "input, textarea, a[href]"。這個設計很貼心——它讓 checkbox 和連結仍可正常點擊,不會一按就變成拖曳。
dragEnd:拖完之後的回呼,通常用來把新順序存回後端。
dragBetween:設為 true 才能跨清單拖放,預設 false。
placeHolderTemplate:拖曳過程中佔位元素的 HTML,預設 "<li></li>"。樣式上表裡那個虛線框就是靠 .placeHolder 做出來的。
scrollContainer / scrollSpeed:頁面要捲動時的容器與速度,設 0 可關閉自動捲動。
方案二:jQuery UI sortable()
如果專案本來就載了 jQuery UI,那 sortable 是更省事的選擇,內建動畫、鍵盤操作與觸控支援都比較完整。
. 代碼如下:
<!DOCTYPE html>
<html>
<head>
<title>jQuery UI sortable() 拖曳排序</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<script src="https://code.jquery.com/jquery-1.7.2.min.js"></script>
<script src="https://code.jquery.com/ui/1.10.3/jquery-ui.js"></script>
</head>
<body>
<script>
$(function() {
$(".sortable").sortable({
cursor: "move",
items: "li", // 只有 li 可以拖
opacity: 0.6, // 拖曳中半透明
revert: true, // 放開時播放歸位動畫
update: function(){
alert($(this).sortable("toArray"));
}
});
});
</script>
<ul class="sortable">
<li class="ui-state-default" id="1">第1項</li>
<li class="ui-state-default" id="2">第2項</li>
<li class="ui-state-default" id="3">第3項</li>
</ul>
</body>
</html>
這裡的 toArray() 很值得記住:它會把所有可排序子元素的 id 依目前順序收集成陣列,直接就是可以丟給後端的排序結果,不必像 dragsort 那樣自己寫 saveOrder。
怎麼選
只需要單純清單排序、不想多載一個 UI 函式庫,用 dragsort。專案已有 jQuery UI、或需要跨清單拖放加上鍵盤無障礙操作,用 sortable。兩個方案都請記得:拖完一定要把順序存回資料庫,否則使用者重新整理就白做工了。
最後補一句現實面的建議:這兩套都是 jQuery 1.x 時代的產物,dragsort 早已停止維護。若是新專案,我會直接採用 SortableJS 或 dnd-kit,API 概念幾乎一樣,但支援行動裝置觸控、也不必綁 jQuery。