DIV CSS 佈局教程網

純原生 JavaScript 打造輕量 DataGrid:排序、編輯、拖拽、分頁一次到位
編輯:關於JavaScript     

做後台系統時,表格幾乎是出現頻率最高的元件。市面上成熟方案不少,但有時候你就是需要一個沒有依賴、行為完全可控、體積又小的表格。下面這份實作用的是最原始的 HTML、CSS 與 JavaScript,把常見的表格能力自己拼了一遍。

這個表格能做到什麼

1. 排序,並支援自訂排序規則

2. 行內編輯

3. 拖曳調整欄寬

4. 分頁與跳頁

5. 單選、Ctrl 多選、Shift 連選

6. 文字 render,例如餘額大於 0 顯示紅色、小於 0 顯示綠色

7. 欄位的顯示與隱藏

8. 資料分組

它只是一個示範,沒有真的接後端介面。真要接後端並不難,補上幾個回呼函式即可;元件本身已經內建 loading 遮罩,在資料還沒回來之前會一直轉。

整體結構

整個元件由幾個 div 撐起來:最外層 container,裡面依序是標題列、上方分頁工具列、表格容器 tabcontainer、下方分頁工具列,最後蓋上兩層 loading 節點(半透明遮罩與中央提示框)。表格本體則是傳統的 table > thead + tbody。

初始化時不會為每一筆資料建立節點,而是先按 perPage 產生一批空的 tr 放進 tbody,後續所有更新都只是往這些既有格子裡填字。資料量大時,這個做法比反覆新增/移除節點要順得多。

欄位設定決定一切

欄位api是整個元件的設定核心,每個欄位可以宣告名稱、對應的資料鍵名、型別、寬度,以及是否可編輯:

fields: [
  {name:'序號', param:'id',   type:'int',    width:'100'},
  {name:'名稱', param:'name', type:'string', edit:'edit', width:'140'},
  {name:'餘額', param:'money',type:'float',  edit:'edit', render:xx, width:'100'},
  {name:'幣種', param:'type', type:'string', edit:'edit', width:'100'},
  {name:'日期', param:'date', type:'date',   edit:'edit', width:'100'},
  {name:'備註', param:'note', type:'string', width:'255'}
]

有 edit 的欄位會在使用者雙擊該列時,出現在浮動的編輯表單裡;沒有 edit 的欄位在編輯表單中會被設為唯讀。

排序:型別決定比較方式

表頭 td 上會寫入 type-xxx 的 class,點擊時讀出型別,再到 sortType 表中取出對應的轉型函式來比較。內建 int、float、date、string 四種,找不到對應型別時退回 string。

compare: function (n, type) {
  var sortType = this.defaults.sortType,
      txt = Sys.ie ? 'innerText' : 'textContent';
  !sortType[type] && (type = 'string');
  return function (a1, a2) {
    a1 = sortType[type](a1.cells[n][txt]);
    a2 = sortType[type](a2.cells[n][txt]);
    return a1 == a2 ? 0 : (a1 < a2 ? 1 : -1);
  };
}

因為比較函式是查表得來的,擴充自訂排序只要往 sortType 上掛一個方法就好。例如下面讓「很好/一般/很差」這種文字欄位也能正確排序:

easyGrid.prototype.options.sortType.cp = function (v) {
  if (v === '很好') return 3;
  if (v === '一般') return 2;
  if (v === '很差') return 1;
};

再次點擊同一個表頭會在正序與反序之間切換,並透過 sort-asc/sort-desc 兩個 class 在表頭畫上箭頭。若表格有分組,排序會在各分組內部獨立進行,不會把不同組的資料混在一起。

分頁與資料來源

分頁相關的參數有四個:perPage(每頁幾筆)、currPage(目前頁)、totalPage(總頁數)、count(一次取多少筆)。首、上、下、末頁與跳轉都集中在 pageBarClick 處理,頁碼超出範圍時會被夾到合法區間,工具列上的箭頭也會依目前位置切換成不可點擊的灰色樣式。

資料以陣列形式傳入 dataConfig,元件收到後呼叫 getDataCallBack 正規化,再交給 buildTbody 渲染。翻頁時會先隱藏 tbody、顯示 loading,稍作延遲後才重建內容,避免連續 clicks 造成畫面閃動。

選取、拖曳與欄位開關

選取邏輯集中在 selectRow:沒有按修飾鍵就是單選並清掉舊的選取;按 Ctrl 是在目前的選取集合裡增刪;按 Shift 則以最後一次點擊的位置為錨點做區間選取。所有被選取的行都記在 selectedRows 這個以遞增 uuid 為鍵的物件裡,刪除時只要取出對應的 dataIndex 往後端送即可。

欄寬拖曳靠表頭裡一個寬 1px 的 p 當把手。按下時在 body 上放一條基準線 line,移動過程中限制最小寬度(cellMinWidth,預設 50px),放開時把差值攤到左右兩欄上。

點擊表頭的箭頭會彈出第一層選單(升序/降序/所有列),滑到「所有列」再展開第二層,用一串 checkbox 控制每一欄的顯示。這裡有兩個細節值得注意:一是至少要保留一欄可見,取消最後一欄時會被強制還原;二是啟用分組時,隱藏欄位後必須同步更新分組標題列的 colSpan,否則表頭會錯位。

分組與文字著色

分組資料的格式是在每組外面包一層物件:

{
  total: 11,
  data: [
    { groupName: '平安銀行', rows: [ [1,'平安銀行信用卡-賬單','-29792.66','日元','1928-06-15','一般'] ] },
    { groupName: '交通銀行', rows: [ [151,'交通銀行信用卡-賬單','10634.01','英磅','1967-09-23','很好'] ] }
  ]
}

元件會在每組的第一列前插入一個跨滿所有欄位的分組標題列,並記錄每組的起始位置,後續排序或隱藏欄位時再一併維護。

文字著色則交給欄位設定裡的 render。下面這個例子把負數標成綠色、正數標成紅色:

function xx(v) {
  return ~~v < 0
    ? '<span class="greed">' + v + '</span>'
    : '<span class="red">'   + v + '</span>';
}

建立一個表格

new easyGrid({
  container : $$('demo'),
  primaryKey: 'id',          // 刪除、編輯時需要主鍵
  fields    : [ /* 前面那份欄位設定 */ ],
  dataConfig: data,
  perPage   : 1000,          // 每頁筆數
  currPage  : 0,
  totalPage : 0,
  count     : 2000,          // 一次取多少筆
  page      : 0              // 第幾批資料
});

寫完之後的感想

這個元件刻意沒有依賴任何框架,好處是每一行行為都能自己掌握,壞處是這些能力放到今天的專案裡,多半已經有現成且更完整的方案可用。不過作為一次練習,它把表格裡那些「看起來簡單、實作起來瑣碎」的環節都摸過一遍:事件委派、節點複用、排序時的分組處理、拖曳時的邊界判斷。這些經驗在別的場景一樣用得上。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved