寫 jQuery 插件其實有幾個約定俗成的模板,掌握它們之後,要讀懂或改寫別人的插件都會輕鬆很多。以下介紹最常見的兩種定義方式。
(function ($){
$.fn.插件名 = function (settings){
// 預設參數
var defaultSettings = {};
// 合併預設參數與使用者自訂參數
settings = $.extend(defaultSettings, settings);
return this.each(function(){
// 實際處理邏輯
});
}
})(jQuery);
這裡有兩個關鍵細節:
第一,(function ($){ ... })(jQuery) 建立了一個匿名函數並立刻執行,同時把 jQuery 傳入、以 $ 承接。這樣做的好處是:即使頁面上其他函式庫佔用了 $,插件內部依然安全。若對匿名函數與閉包不熟,建議先補這塊基礎觀念。
第二,$.extend 在插件開發中扮演「合併參數」的重要角色,讓使用者只需傳入想改的項目:
$.fn.tip = function (settings){
var defaultSettings = {
color: 'yellow", // 顏色
timeout: 200 // 延遲
};
settings = $.extend(defaultSettings, settings);
alert(settings.input);
}
另外,return this.each(...) 是為了保持 jQuery 的鏈式呼叫特性 —— 呼叫完插件後還能接著串其他方法。
當插件擁有多個對外方法時,可以把它們收在一個 methods 物件中,再由入口函數分派:
(function ($){
$.fn.tabpanel = function (method){
var methods = $.fn.tabpanel.methods;
if (methods[method]){
return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
} else if (typeof method === 'object' || !method){
return methods.init.apply(this, arguments);
}
};
$.fn.tabpanel.methods = {
init: function (p_options){
tabpanelBind(p_options, this);
},
add: function (p_options){
addTab(p_options, this);
tabpanelBind(p_options, this);
}
};
function add(p_options){
var _defaults = { id: "" };
// 內部實作略
return _index;
}
})(jQuery);
呼叫方式:
$("#team").tabpanel('add', "");
這種結構的優點是:對外介面清楚、內部方法可自由增減,也便於未來擴充。先把這兩種寫法練熟,之後再談更深層的設計會順很多。