萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

jQuery tableDnD 插件實現表格行拖拽排序:從入門到工程化實戰

插件介紹:tableDnD

專為 <table> 行拖拽排序設計的 jQuery 插件,特點:

  • 零配置即可用:$('table').tableDnD()
  • 自動處理 tr 拖拽視覺反饋
  • 支援 onDrop、onDragStart、onDragClass 回調
  • 輕量(~3KB gzipped)

快速上手:最小可用示例

<!-- 1. 引入依賴(順序關鍵!) -->
<script src="https://cdn.jsdelivr.net/npm/jquery@3.7.1/dist/jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/jquery-tablednd@0.7.0/jquery.tablednd.min.js"></script>

<!-- 2. 表格結構:每行必須有 id -->
<table id="sortableTable">
  <thead><tr><th>#</th><th>名稱</th><th>操作</th></tr></thead>
  <tbody>
    <tr id="row-1"><td>1</td><td>項目一</td><td><button class="del">刪除</button></td></tr>
    <tr id="row-2"><td>2</td><td>項目二</td><td><button class="del">刪除</button></td></tr>
    <tr id="row-3"><td>3</td><td>項目三</td><td><button class="del">刪除</button></td></tr>
  </tbody>
</table>

<script>
$(function() {
  // 3. 一鍵啟用
  $('#sortableTable').tableDnD({
    onDrop: function(table, row) {
      // row 是被拖拽的 tr 元素
      const newOrder = $(table).tableDnD().serialize(); // 獲取新順序
      console.log('新順序:', newOrder); // "row-2&row-1&row-3"
      saveOrderToServer(newOrder); // AJAX 保存
    },
    onDragStart: function(table, row) {
      $(row).addClass('dragging'); // 拖拽中樣式
    },
    dragHandle: '.drag-handle' // 可選:指定拖拽手柄(如圖標)
  });
  
  // 序列化輔助:返回 "id1&id2&id3" 格式
  $.fn.tableDnD.serialize = function() {
    return this.find('tbody tr').map((i, tr) => tr.id).get().join('&');
  };
});
</script>

進階配置:斑馬紋自動維護


$('#sortableTable').tableDnD({
  onDrop: function(table, row) {
    // 1. 保存順序
    saveOrder($(table).tableDnD().serialize());
    // 2. 重新套用斑馬紋
    applyStriping(table);
  }
});

function applyStriping(table) {
  $(table).find('tbody tr').each(function(i) {
    $(this).removeClass('odd even')
           .addClass(i % 2 === 0 ? 'odd' : 'even');
  });
}

// CSS
.odd  { background: #f9f9f9; }
.even { background: #ffffff; }
.dragging { background: #e3f2fd !important; box-shadow: 0 2px 8px rgba(0,0,0,.15); }

關鍵坑點與解決方案

問題原因解決方案
拖拽無反應jQuery 引入順序錯誤**先載入 jQuery,再載入 tableDnD**
行無法拖動tr 缺少 id 屬性每行必須有唯一 id
表頭被拖動未排除 thead插件自動忽略 thead,確保結構正確
斑馬紋錯亂拖拽後類名未更新onDrop 中調用 applyStriping()
輸入框無法編輯拖拽事件攔截點擊設置 dragHandle: '.handle' 限制拖拽區域
動態新增行不可拖拽插件綁定在初始化時刻新增行後調用 $('#table').tableDnDUpdate() 重新綁定

動態數據綁定完整流程

// 1. 從服務器獲取數據並渲染
function loadTableData() {
  $.getJSON('/api/items', data => {
    const html = data.map(item => 
      `${item.sort}${item.name}`
    ).join('');
    $('#sortableTable tbody').html(html);
    
    // 2. 重新初始化/更新拖拽綁定
    initDrag();
  });
}

function initDrag() {
  $('#sortableTable').tableDnD({
    onDrop: (table, row) => {
      const order = $(table).find('tbody tr').map((i, tr) => tr.id.replace('row-', '')).get().join(',');
      $.post('/api/items/reorder', { order });
      applyStriping(table);
    }
  });
}

// 3. 動態新增行後更新
function addRow(name) {
  $.post('/api/items', { name }, newRow => {
    $('#sortableTable tbody').append(
      `${newRow.sort}${name}`
    );
    $('#sortableTable').tableDnDUpdate(); // 關鍵:更新綁定
    applyStriping($('#sortableTable')[0]);
  });
}

現代替代方案:SortableJS(推薦新項目)

<script src="https://cdn.jsdelivr.net/npm/sortablejs@1.15.0/Sortable.min.js"></script>

<script>
new Sortable(document.querySelector('#sortableTable tbody'), {
  animation: 150,
  handle: '.drag-handle',     // 拖拽手柄
  ghostClass: 'sortable-ghost', // 拖拽佔位樣式
  dragClass: 'dragging',      // 拖拽中樣式
  onEnd: evt => {
    const order = [...evt.to.children].map(tr => tr.id.replace('row-', '')).join(',');
    saveOrder(order);
    applyStriping(evt.to);
  }
});
</script>

優勢:無 jQuery 依賴、支援觸屏、TypeScript 類型定義完善、活躍維護中。

總結

tableDnD 是 jQuery 時代表格拖拽排序的經典解法,核心要點:

  1. tr 必須有 id 作為標識
  2. onDrop 回調 中序列化新順序並持久化
  3. 斑馬紋維護:CSS :nth-child 最優,JS 兜底
  4. 動態更新:tableDnDUpdate() 重新綁定

新項目**強烈建議直接使用 SortableJS**,避免 jQuery 依賴,獲得更好觸屏體驗與現代工程化支援。

copyright © 萬盛學電腦網 all rights reserved