jQuery 為外掛開發提供了兩個入口:jQuery.fn.extend(object) 與 jQuery.extend(object)。兩者只差一個 fn,用途卻完全不同,本文把它們的關係說清楚。
翻開 jQuery 原始碼就不難發現:
jQuery.fn = jQuery.prototype = {
init: function (selector, context) {
// ...
}
// ...
};
原來 jQuery.fn 就是 jQuery.prototype。雖然 JavaScript 沒有明確的 class 概念,但用類別來理解會方便得多——jQuery 就是一個封裝得很好的類別,我們寫 $("#btn1") 時,其實是建立了一個 jQuery 類別的實例。
$.extend({
add: function (a, b) { return a + b; }
});
$.add(3, 4); // 回傳 7
這等於為 jQuery 類別新增一個靜態方法,引入 jQuery 的任何地方都能用 $.方法名 呼叫。像 $.ajax()、$.each()、$.trim() 都屬於這一類。
對 jQuery.prototype 進行擴充,就是為 jQuery 類別新增成員函式,讓所有實例都能使用。舉個簡單例子:做一個特殊輸入框,被點擊時就跳出目前的內容。
$.fn.extend({
alertWhileClick: function () {
$(this).click(function () {
alert($(this).val());
});
}
});
// 頁面上為 <input id="input1" type="text"/>
$("#input1").alertWhileClick();
$("#input1") 是一個 jQuery 實例,呼叫成員方法 alertWhileClick() 之後就完成了擴充:每次被點擊,它會先跳出輸入框目前的內容。
真實的開發不會寫這麼小白的外掛。一個比較完整的結構通常長這樣,重點是保留 return this 以支援鏈式呼叫,並用 each 處理多元素:
(function ($) {
$.fn.myPlugin = function (options) {
var settings = $.extend({
color: '#f00',
delay: 300
}, options || {});
return this.each(function () {
var $el = $(this);
$el.hover(
function () { $el.css('color', settings.color); },
function () { $el.css('color', ''); }
);
});
};
})(jQuery);
// 使用
$("p").myPlugin({ color: 'blue', delay: 500 }).addClass('done');
而外掛原始碼包在 (function ($) { ... })(jQuery) 裡,是為了在作用域內安全地使用 $,即使頁面其他地方的 $ 已被別的函式庫佔用也不受影響。
由於 jQuery 本身已提供豐富的文件操作、事件、CSS、Ajax 與效果方法,把這些能力組合起來,就能做出相當實用的外掛。