工作需要一個 JS 分頁插件。與其上网找一個結構不清楚的,出問題時無從下手,功能又多半多到用不上、徒增載入量,不如自己寫一個——順便練手。以下是完整的思路記錄。
Demo:https://demo.cnblogs.com/js/2014/EasyPage/
後端把查詢結果全部輸出到頁面,由這個插件負責讓它們一頁一頁顯示。需要具備:上一頁、下一頁、首頁、尾頁;在第一頁時隱藏「上一頁」與「首頁」;在最後一頁時隱藏「下一頁」與「尾頁」;一次只顯示幾個頁碼按鈕,點到目前這組的最後一個時,往後展現下一組。
// 為更好的相容性,開頭先加分號
;(function ($) {
// 插件程式碼寫在這裡
})(jQuery);
這段是 jQuery 插件的標準結構,也就是 JavaScript 的閉包。用它的好處有兩個:内部的臨時變數不會污染全域空間;同時可以在閉包內繼續用 $ 作為 jQuery 的別名,不必擔心與其他使用 $ 的庫衝突。
jQuery 提供兩個擴充入口:
· jQuery.extend(object) 擴充 jQuery 物件本身,用來在 jQuery 命名空間上增加新函式。
· jQuery.fn.extend(object) 擴充 jQuery 元素集,提供新的方法(通常用來做插件)。
差別可以用另一種語言的觀念理解:jQuery.extend() 相當於加上靜態方法,寫成 jQuery.max() 呼叫;而 jQuery.fn 就是 jQuery.prototype,在它上面擴充等於加上成員函式,只有 jQuery 實例能呼叫,例如 jQuery("#my").max()。
jQuery.extend({ "max": function () { return max; } });
jQuery.max(); // 靜態呼叫
這個分頁插件採用了 jQuery.extend:
;(function ($) {
$.extend({
"easypage": function (options) {
options = $.extend({ // 參數設定
contentclass: "contentlist", // 要分頁的內容 class
navigateid: "navigatediv", // 導航列容器的 id
everycount: "5", // 每頁顯示幾筆
navigatecount: "5" // 導航按鈕一次顯示幾個
}, options);
}
});
})(jQuery);
easypage 是呼叫時使用的方法名,其餘四個是可自訂的參數。
var currentpage = 0; // 目前頁
var contents = $("." + options.contentclass); // 要分頁的內容
var contentcount = contents.length; // 內容總筆數
var pagecount = Math.ceil(contentcount / options.everycount); // 總頁數
// 拼接導航按鈕
var navigatehtml = "<div id='pagefirst' class='pagefirst'><a href='javascript:void(0)'>首頁</a></div>"
+ "<div id='pagepre' class='pagepre'><a href='javascript:void(0)'>上一頁</a></div>";
for (var i = 1; i <= pagecount; i++) {
navigatehtml += '<div class="pagenavigate"><a href="javascript:void(0)">' + i + '</a></div>';
}
navigatehtml += "<div id='pagenext' class='pagenext'><a href='javascript:void(0)'>下一頁</a></div>"
+ "<div id='pagelast' class='pagelast'><a href='javascript:void(0)'>尾頁</a></div>";
$("#" + options.navigateid).html(navigatehtml);
// 隱藏所有導航按鈕
$.extend({
"hidenavigates": function () {
navigates.each(function () { $(this).hide(); });
}
});
// 顯示一組導航按鈕
$.extend({
"shownavigate": function (currentnavigate) {
$.hidenavigates();
// 目前按鈕若小於一組的數量,就從 0 開始顯示
var begin = currentnavigate >= options.navigatecount
? currentnavigate - parseInt(options.navigatecount) : 0;
// 保證從第二頁起,每次顯示的按鈕數量為 2 * navigatecount
if (begin > navigates.length - 2 * options.navigatecount) {
begin = navigates.length - 2 * options.navigatecount;
}
for (var i = begin; i < currentnavigate + parseInt(options.navigatecount); i++) {
$(navigates[i]).show();
}
}
});
其餘的翻頁、頁碼高亮、首末頁隱藏等邏輯都在附件原始碼裡,註解寫得頗詳細。
· 檔名建議為 jquery.[插件名].js,例如 jquery.color.js。
· 所有物件方法都掛在 jQuery.fn 上,所有全域函式都掛在 jQuery 本身上。
· 插件內部 this 指向的是選到的 jQuery 物件;而像 click() 這類方法的內部,this 指向的是 DOM 元素。
· 用 this.each() 遍歷所有元素。
· 每個方法都以分號結尾,否則壓縮時可能出問題;更穩妥的做法是在插件開頭補一個分號。
· 插件應該回傳 jQuery 物件以維持鏈式操作,除非它本來就是要回傳字串、陣列這類結果值。
· 善用閉包避免變數名衝突。
示範中把 currentpage、contents、navigates 都放在閉包外層成為全域變數,這其實違背了「用閉包隔離狀態」的初衷,也導致同一頁面無法初始化兩個分頁。正確做法是把這些狀態收進一個以元素為 key 的物件,或用 .data() 掛在容器上。
另外,href='javascript:void(0)' 已不建議使用,改用 <button> 並在 CSS 中重置樣式會更語意、也更無障礙友善;頁碼列應加上 aria-label 與 aria-current,讓螢幕閱讀器能正確朗讀目前所在頁。
第一次寫插件難免有生澀之處,但走完這一趟之後,再看到別人的插件原始碼,就有能力判斷它為什麼這樣寫了。