做過幾個專案、寫出幾個外掛之後,會發現結構其實大同小異。下面這份模板已經足夠應付大多數情況,跟網路上流傳的版本差異不大,但勝在清楚。
;(function($) {
// Private functions.
var p = {};
p.func1 = function() { };
// main plugin body
$.fn.PLUGIN = function(options) {
// Set the options.
options = $.extend({}, $.fn.PLUGIN.defaults, options);
// Go through the matched elements and return the jQuery object.
return this.each(function() {
});
};
// Public defaults.
$.fn.PLUGIN.defaults = {
property: 'value'
};
// Public functions.
$.fn.PLUGIN.method1 = function(skinName) {
return;
};
})(jQuery);
私有函式區。放在 p 這個物件上的方法不對外暴露,只能在外掛內部使用。把輔助邏輯關在這裡,是保持 API 乾淨的關鍵。
外掛主體。$.fn.PLUGIN 就是使用者呼叫的入口。兩個重點:$.extend({}, defaults, options) 讓使用者只需傳入要改的設定,其餘沿用預設值;return this.each(...) 則保證多元素與鏈式呼叫都能正常運作。
預設值區。獨立成 $.fn.PLUGIN.defaults 有兩個好處:一是主體更精簡,二是使用者可以全域覆寫預設值,不必每次呼叫都重傳。
公開方法區。挂在 $.fn.PLUGIN 上的方法會成為外掛的子 API,讓使用者能在初始化之後再操作,例如切換主題。
開頭那個 ; 不是裝飾。如果前一個腳本結尾漏了分號,你的 IIFE 可能會被解析成「呼叫前一個語句的回傳值」,導致莫名的語法錯誤。加上分號是最省事的防禦。
模板裡的 each 是空的,實際開發時通常還需要:用 $.data() 保存每個元素的狀態,避免全域變數在多實例時互相干擾;在初始化時檢查是否已初始化過,避免重複綁定事件;以及提供 destroy 方法把綁定的事件與資料清乾淨。這幾點做到,外掛就算完整了。