把常用功能包成 jQuery 插件,不只自己省事,也能讓程式碼結構更清楚。撰寫前先掌握幾條社群公認的慣例,可以少走很多彎路。
jquery.[插件名].js,例如 jquery.color.js,以免與其他函式庫的插件混淆。jQuery.fn 上;所有「全域函式」則掛在 jQuery 本體上。this 指向的是透過選擇器取得的 jQuery 物件,而非一般 DOM 方法那樣指向單一元素。this.each() 遍歷集合中的所有元素。$ 作為別名,改用完整的 jQuery,以免與其他函式庫衝突;也可以利用閉包技巧在內部安全地使用 $。// 開頭的分號是為了更好的相容性
;(function($){ // 把 $ 作為匿名函式的形參
// 用 $.fn.extend 擴充插件
$.fn.extend({
"color": function(value){ // color 為自訂的插件方法名
// jQuery 已提供 css 方法,這裡只是示範
return this.css("color", value);
}
});
})(jQuery); // 把 jQuery 作為實參傳入
function red(){
alert($("#div").color() + " 證明插件可用");
alert($("#div").color("red") + " 證明插件回傳了一個 jQuery 物件");
$("#div").color("red");
}
在 HTML 中使用:
<body>
<div id="div" onclick="red()">dddddddddddddddd</div>
</body>
上面的例子只示範了閉包與 $.fn.extend。真正要發布的插件,通常還需要三件事:預設值合併、鏈式支援、以及避免多實例衝突。
;(function($){
$.fn.myPlugin = function(options){
var settings = $.extend({
color: "#333",
fontSize: "14px"
}, options || {});
return this.each(function(){
$(this).css({
color: settings.color,
fontSize: settings.fontSize
});
});
};
})(jQuery);
// 使用
$("p").myPlugin({ color: "red" });
return this.each(...) 是重點,它同時解決了「回傳 jQuery 物件」與「支援多元素」兩個問題。若想對外公開可呼叫的方法,可再包一層 $.fn.myPlugin = function(method){ ... } 的分派器,這就是大多數成熟插件的架構。