把常用的 DOM 操作包成插件,是提升重用度最直接的方式。以下用一個最小可用的例子走一遍標準流程。
(function ($) {
$.fn.extend({
// 插件名稱
height: function (options) {
// 預設參數
var defaults = {
color: '紅色'
};
// 以使用者傳入的值覆蓋預設值
var opts = $.extend(defaults, options);
// 主函數:each 保住鏈式呼叫
return this.each(function () {
var obj = $(this);
obj.click(function () {
alert(opts.color);
});
});
}
})
})(jQuery);
// 注意:後面的 (jQuery) 必須如此,Q 大寫、j 小寫,否則會出錯
@{
ViewBag.Title = "Home Page";
}
@section Header{
<script src="@Url.Content("~/Scripts/jquery.extends.js")" type="text/javascript"></script>
<script type="text/javascript">
$(function () {
$("p").height({ color: '黑色' });
});
</script>
}
<h2>@ViewBag.Message</h2>
<p>
To learn more about ASP.NET MVC visit
<a href="https://asp.net/mvc" title="ASP.NET MVC Website">https://asp.net/mvc</a>.
</p>
1. 用 IIFE 包住並傳入 jQuery。(function($){ ... })(jQuery) 的好處是插件內部可以安心使用 $,即使頁面其他地方呼叫了 jQuery.noConflict() 也不受影響。
2. 用 $.extend 合併參數。把預設值與使用者傳入值合併,使用者只需關心自己想改的項目。
3. 一定要 return this.each()。這維持了 jQuery 的鏈式呼叫特性,$("p").height({...}).css({...}) 才能寫下去。少了這行,插件就變成「斷鏈」的孤兒。
4. 命名避免與內建方法衝突。這個範例把插件取名為 height,其實會覆蓋 jQuery 原有的 .height(),實務上絕對要避免;加上專案前綴(如 mytoolHeight)才是安全做法。
熟悉基本骨架後,可以再往三個方向補強:用 $.data() 儲存插件實例狀態、加上 destroy 方法以便完整解除綁定、以及用 $.widget(jQuery UI 提供的 Widget Factory)自動取得 destructor 與選項管理。不過多數情況下,上面這三十行就足夠應付日常需求了。