寫 jQuery 外掛有兩條路:一是擴充全域函式,呼叫方式是 $.funcName();二是擴充物件方法,呼叫方式是 $('selector').funcName()。兩者的用途與實作方式都不同,以下分別說明。
全域函式是把獨立函式掛到 jQuery 的命名空間上,透過 $.funcName(param) 或 jQuery.funcName(param) 呼叫。
jQuery.sayHello = function(name) {
alert(name + "您好");
};
呼叫方式:
jQuery.sayHello("張子涵");
// 或者用 $.sayHello("張子涵");
extend() 的作用是用一個或多個物件去擴充另一個物件,並回傳被擴充的物件。它有兩種形態:
jQuery.extend(dsc, src1, src2...):把 src1、src2 合併進 dsc 物件,並回傳合併後的 dsc(物件合併)。jQuery.extend(object):對 jQuery 命名空間本身進行擴充,結果就是在 jQuery 上增加函式。// 在 jQuery 命名空間上增加兩個函式
jQuery.extend({
min: function(a, b) { return a < b ? a : b; },
max: function(a, b) { return a > b ? a : b; }
});
呼叫方式:
jQuery.min(2,3); // => 2
jQuery.max(4,5); // => 5
一次 extend 就能掛上多個函式,這也是為什麼它比逐一指派更常用。
物件方法的擴充讓所有 jQuery 物件(也就是 $() 選到的元素集合)都能呼叫該方法,這是做外掛最典型的形式。
jQuery.fn 其實就是 jQuery.prototype 的別名,往它上面掛方法,所有 jQuery 物件都會繼承。
// 在 jQuery 物件上添加 sayHello 方法
jQuery.fn.sayHello = function(name) {
alert(name + "您好");
};
呼叫:
$("div").sayHello("dwqs");
用來擴充 jQuery 元素集合以提供新方法,通常用來製作外掛。
// 增加兩個外掛方法
jQuery.fn.extend({
check: function() {
return this.each(function() { this.checked = true; });
},
uncheck: function() {
return this.each(function() { this.checked = false; });
}
});
呼叫:
$("input[type=checkbox]").check();
$("input[type=radio]").uncheck();
注意上面 check 與 uncheck 都 return this.each(...),這不是隨手寫的:回傳 this 才能維持 jQuery 的鏈式呼叫,讓使用者能寫 $('input').check().addClass('done')。這是 jQuery 外掛最重要的設計慣例。
其他建議:把外掛包在 IIFE 中並傳入 jQuery 參數((function($){ ... })(jQuery);),避免與其他使用 $ 別名的函式庫衝突;用 $.extend 合併 defaults 與使用者的 options,讓外掛可設定;在檔案開頭加上外掛名稱、版本與作者資訊。至於物件方法與全域函式的選擇判斷很簡單:需要針對選到的元素操作就掛在 fn 上,屬於純工具性質、與元素無關的就掛在命名空間上。