寫插件的核心目的,是把既有的一組方法或函數封裝起來,讓它在別的專案裡可以重複使用,後期維護也相對輕鬆。jQuery 除了提供操作元素與管理腳本的簡便方式,還開放了一套擴充機制,讓我們能把自訂方法掛進核心模組,打造屬於自己的工具庫,進而提升開發效率。
第二型別的寫法非常直接:
jQuery.foo = function () {
alert('This is a test. This is only a test.');
};
jQuery.bar = function (param) {
alert('This function takes a parameter, which is "' + param + '".');
};
呼叫方式與一般函數相同:jQuery.foo();、$.bar('bar');。
jquery.[插件名].js 的慣例。jQuery.fn 上,全域函數則掛在 jQuery 本體上。this 指向的是選到的 jQuery 物件,而不是單一 DOM 元素。this.each()。$ 作為別名,改用完整的 jQuery,以免與其他庫衝突。jQuery 提供 jQuery.fn.extend() 與 jQuery.extend()。前者對應物件層級插件,後者對應類別層級與靜態工具。
其中 jQuery.extend() 最常被拿來做物件合併:
var result = $.extend({}, { name: "Tom", age: 21 }, { name: "Jerry", sex: "Boy" });
// result = { name: "Jerry", age: 21, sex: "Boy" }
後者若有同名屬性,會直接覆蓋前者。
即使 jQuery 已經盡量避開了常見的 JavaScript 名稱,仍可能與其他插件撞名。把方法收進自訂命名空間是個好習慣:
jQuery.myPlugin = {
foo: function () { alert('This is a test.'); },
bar: function (param) { alert('"' + param + '"'); }
};
// 呼叫
$.myPlugin.foo();
$.myPlugin.bar('baz');
插件名就是掛在 $.fn 上的屬性名,基本骨架如下:
(function ($) {
$.fn.myPlugin = function () {
// 功能實作
};
})(jQuery);
我們的第一個插件功能很單純:讓元素慢慢淡出。建立 MyPlugin.js:
(function ($) {
$.fn.myPlugin = function () {
this.fadeOut('normal');
};
})(jQuery);
頁面中依序載入 jQuery 與插件,然後就能呼叫:
<script src="Scripts/jquery-1.4.1.js" type="text/javascript"></script>
<script src="MyPlugin.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function () {
$("#btn1").click(function () {
$("#div1").myPlugin();
});
});
</script>
點下按鈕,div 便會以 normal 速度淡出。順帶一提,掛上 $.fn 之後,編輯器也能給出智慧提示:

(function ($) {
$.fn.hoverElement = function () {
this.each(function () {
$(this).hover(
function () { $(this).addClass("Add"); },
function () { $(this).removeClass("Remove"); }
);
});
};
})(jQuery);
搭配三個同 class 的 div,一次呼叫就能讓全部元素都具備滑入變色的效果:
$(".hoverText").hoverElement();
所謂鏈式,就是 $("#div1").css("color","red").addClass("Add").animate(...) 這種一路點下去的寫法。要讓自己的插件也支援,只需在 this.each() 前加上 return:
$.fn.hoverElement = function () {
return this.each(function () { /* ... */ });
};
// 於是可以這樣寫
$(".hoverText").hoverElement().css("color", "yellow");
商業級插件幾乎一定要開放樣式自訂,例如 width、height、url、color。若全部寫死,插件的 reuse 價值會大幅下降。骨架是 $.fn.YouPlugin = function (options) {...},並搭配 $.extend() 合併預設值與使用者傳入值:
(function ($) {
$.fn.textHover = function (options) {
var defaultVal = {
Text: 'Your mouse is over',
ForeColor: 'red',
BackColor: 'gray'
};
var obj = $.extend(defaultVal, options);
return this.each(function () {
var selObject = $(this);
var oldText = selObject.text();
var oldBgColor = selObject.css("background-color");
var oldColor = selObject.css("color");
selObject.hover(function () {
selObject.text(obj.Text);
selObject.css("background-color", obj.BackColor);
selObject.css("color", obj.ForeColor);
}, function () {
selObject.text(oldText);
selObject.css("background-color", oldBgColor);
selObject.css("color", oldColor);
});
});
};
})(jQuery);
使用時,有傳參數就用自己的設定,沒傳就退回預設值:
$('#div1').textHover({ Text: 'I am going to over..', ForeColor: 'yellow', BackColor: 'Red' });
$('#div2').textHover({ Text: 'I am second div...' });
到這裡,一個插件該有的要素——命名規範、鏈式回傳、多元素遍歷、參數自訂——就都齊備了。