寫 jQuery 插件,第一步是搞懂兩件事:插件有哪幾種,以及 jQuery.extend() 與 jQuery.fn.extend() 到底差在哪。
絕大多數插件屬於這類。它把功能封裝成方法,在 $(selector) 取得 jQuery 物件後呼叫,因此能直接受益於 jQuery 強大的選擇器能力與集合操作——一次作用到多個元素上。
也可以把自訂功能掛到 jQuery 命名空間下,作為 jQuery 作用域中的公用函式。這類函式沒有綁定在 jQuery 物件上,因此不能對 $(selector) 的結果直接呼叫,必須寫成 $.myFunc()。典型的例子是 $.each()、$.noConflict()、$.ajax()——它們操作的不是 DOM 元素,而是陣列、物件或執行某項特定任務。
若覺得 jQuery 內建的選擇器不夠用或不夠方便,可以自行擴充 $.expr 來增加新的過濾器。
jQuery.extend({
minValue : function(a,b){
return a<b?a:b;
},
maxValue : function(a,b){
return a<b?b:a;
}
})
$(function(){
$("input").click(function(){
var a = prompt("請輸入一個數值?");
var b = prompt("請再輸入一個數值?");
var c = jQuery.minValue(a,b);
var d = jQuery.maxValue(a,b);
alert("你輸入的最大值是:" + d + "\n你輸入的最小值是:" + c);
});
})
<input type="button" value="jQuery插件擴展測試" />
用這種方式掛上去的函式,可以直接用 jQuery.minValue() 或 $.minValue() 呼叫($ 只是 jQuery 的別名)。
注意一個容易混淆的點:jQuery.extend() 除了用來建立插件,本身也是個通用的物件合併工具。
var a = {name : "zhu", pass : 123}
var b = {name : "wang", pass : 456, age : 1}
var c = jQuery.extend(a,b);
$(function(){
for(var name in c){
$("div").html($("div").html() + "<br />"+ name + ":" + c[name]);
}
})
這段會把 a 與 b 合併。由於 b 在後,衝突的 key(name、pass)以 b 為準,結果是 {name:"wang", pass:456, age:1}。若要避免修改到 a,傳入空物件作為第一個參數:jQuery.extend({}, a, b);若要進行深層(遞迴)合併,第一個參數傳 true:jQuery.extend(true, {}, a, b)。
也可以完全不用 extend,直接把函式掛成屬性:
jQuery.css8 = {
minValue : function(a,b){
return a<b?a:b;
},
maxValue : function(a,b){
return a<b?b:a;
}
}
$(function(){
$("input").click(function(){
var a = prompt("請輸入一個數值?");
var b = prompt("請再輸入一個數值?");
var c = jQuery.css8.minValue(a,b);
var d = jQuery.css8.maxValue(a,b);
alert("你輸入的最大值是:" + d + "\n你輸入的最小值是:" + c);
});
})
呼叫時寫成 jQuery.css8.minValue(),其中 jQuery.css8 == $.css8。這等於在 jQuery 命名空間下開了一個小型的功能分類,適合把相關的一群工具函式收在一起。
jQuery.fn 就是 jQuery.prototype 的別名。往它上面加方法,所有 jQuery 物件都會立刻擁有這個方法——這才是我們一般說的「寫插件」。
jQuery.fn.test = function(){
alert("這是jQuery物件方法!");
}
$(function(){
$("div").click(function(){
$(this).test();
});
})
等價的寫法是 jQuery.fn.extend({...}),可一次掛多個方法:
jQuery.fn.extend({
test: function(){
alert("這是jQuery物件方法!");
}
});
用 IIFE 包住並傳入 jQuery。寫法為 (function($){ ... })(jQuery);。這樣在插件內部可以安全使用 $,即使頁面其他地方呼叫了 $.noConflict() 也不受影響。
回傳 this 以支援鏈式呼叫。物件方法應在最後 return this(通常是 return this.each(...)),否則 $("div").myPlugin().addClass("x") 這類寫法會因為拿到 undefined 而中斷。
用 $.extend 合併預設值與使用者參數。把 defaults 存在原型或閉包外,避免每次呼叫都重新建立物件,也能讓使用者透過 $.fn.myPlugin.defaults 全域調整預設值:
(function($){
function MyPlugin(element, options){
this.$el = $(element);
this.settings = $.extend({}, $.fn.myPlugin.defaults, options);
this.init();
}
MyPlugin.prototype = {
init: function(){ /* ... */ }
};
$.fn.myPlugin = function(option){
return this.each(function(){
new MyPlugin(this, option);
});
};
$.fn.myPlugin.defaults = { speed: 400 };
})(jQuery);