jQuery 為插件開發提供了兩種主要方式:類級別開發(定義全局函數)與對象級別開發(為 jQuery 對象添加新方法)。本文透過示例逐一說明。
最直接的方式是給 jQuery 添加一個全局函數:
jQuery.foo = function() {
alert('This is a test.');
};
如果希望避免命名空間衝突,可以採用命名空間的方式將相關方法組織在一起:
jQuery.apollo={
fun1:function(){ console.log('fun1'); },
fun2:function(){ console.log('fun2'); }
}
更常見的做法是透過閉包向 $.fn 添加方法,這樣每一個 jQuery 實例都能調用它:
(function($) {
$.fn.pluginName = function() {
};
})(jQuery);
// 插件通過這樣被調用:
$('#myDiv').pluginName();
為了讓插件更靈活,通常會接受一個 options 參數來控制插件行為,並用 $.extend 合併默認配置:
(function($){
$.fn.fun2=function(option){
var defaultOption={ param1:'param1', param2:'param2' }
$.extend(defaultOption,option);
console.log(defaultOption);
}
})(jQuery);
$(function(){
$("body").fun2({ param1:'new Param1' });
});
透過閉包,我們可以將輔助函數隱藏起來,使其無法從外部訪問,從而保持實現的私有性:
(function($) {
// plugin definition
$.fn.hilight = function(options) {
debug(this);
// ...
};
// private function for debugging
// "debug" 方法無法從外部閉包進入,因此對於我們的實現是私有的
function debug($obj) {
if (window.console && window.console.log)
window.console.log('hilight selection count: ' + $obj.size());
};
})(jQuery);