jQuery 是繼 Prototype 之後廣受歡迎的 JavaScript 框架,而它最迷人的地方之一是「擴充性」——你可以寫自己的外掛,把常用邏輯封裝起來,只留一份程式碼維護。這篇記錄我從讀原始碼到寫出第一支外掛的過程。

要做的效果很簡單:滑鼠移到連結上時,連結往右滑一小段並變色;移開後歸位。
<ul id="catagory">
<li><a href="#">星期一</a></li>
<li><a href="#">星期二</a></li>
<li><a href="#">星期三</a></li>
<li><a href="#">星期四</a></li>
</ul>
$(document).ready(function () {
$("#catagory a").hover(function () {
$(this).animate({ paddingLeft: "20px" }, { queue: false, duration: 500 });
}, function () {
$(this).animate({ paddingLeft: "0" }, { queue: true, duration: 500 });
});
});
把邏輯搬進 plugin.js,用 IIFE 包住避免污染全域,透過 $.fn.extend() 掛到 jQuery 原型上:
(function ($) {
$.fn.extend({
// 外掛名稱:paddingList
paddingList: function (options) {
// 參數與預設值
var defaults = {
animatePadding: 10,
hoverColor: "Black"
};
var options = $.extend(defaults, options);
return this.each(function () {
var o = options;
var obj = $(this); // 外掛作用的元素(本例是 ul)
var items = $("li a", obj); // 找出其中的 a
items.hover(function () {
$(this).css("color", o.hoverColor);
// queue: false 表示不加入動畫佇列,避免快速移入移出時堆疊
$(this).animate({ paddingLeft: o.animatePadding }, { queue: false, duration: 300 });
}, function () {
$(this).css("color", "");
$(this).animate({ paddingLeft: "0" }, { queue: true, duration: 300 });
});
});
}
});
})(jQuery);
別忘了外掛之前要先載入 jQuery 本體,然後就能這樣呼叫:
$(document).ready(function () {
$("#catagory").paddingList({ animatePadding: 30, hoverColor: "Red" });
});
用 IIFE 包住並傳入 jQuery。寫成 (function ($) { ... })(jQuery),好處是內部可以安心用 $,即使頁面其他地方呼叫了 jQuery.noConflict() 也不受影響,同時不洩漏任何變數到全域。
用 $.extend 合併預設值。讓使用者只傳需要覆寫的選項,其餘走預設。若要允許深度合併,用 $.extend(true, defaults, options)。
return this.each()。這一行是外掛能被鏈式呼叫的關鍵——回傳 this(也就是 jQuery 物件本身),後面才能再接 .css()、.addClass()。同時 each() 保證外掛對多元素集合時每個都會作用。
用命名空間保護全域。IIFE 內宣告的變數不會外洩,外掛名稱也盡量加上前綴避免與他人衝突。
queue: false 只用在移入、移出卻用 queue: true,快速滑過時仍可能堆積動畫。實務上兩邊都設 false 並在 animate 前呼叫 .stop(true) 會更順。另外,把 duration 也開成可設定選項,外掛的通用性會更高。