寫 jQuery 外掛的門檻不高,但要寫得「像樣」有幾個約定俗成的規範。這一篇用一個極簡的外掛 txtHover,把骨架、事件、自訂選項三件事依序做一遍。
書上最常見的入門寫法是这样的:
jQuery.fn.pluginname = function(){
return this.each(function(){
// code...
})
}
它能動,但直接在全域定義 jQuery.fn.pluginname,等於把自己的命名暴露在可能的衝突風險中。更穩妥的方式是用匿名函式建立一個獨立作用域,把 jQuery 當參數傳進來:
(function($){
$.fn.pluginname = function(){
return this.each(function(){
// code...
});
}
})(jQuery);
這樣一來,函式體內可以自由使用 $,即使頁面其他地方用 jQuery.noConflict() 把 $ 還給別的函式庫,也不會互相干擾。建議也養成把匿名函式相關的知識補齊的習慣,這在後續章節會一直用到。
jquery.pluginname.js,方便辨識與管理。this.each() 會遍歷所有符合條件的元素,本身仍是 jQuery 物件,最後把它返回,就自然實現了鏈式呼叫。(function($){
$.fn.txtHover = function(){
return this.each(function(){
$(this).text('text changed!');
});
}
})(jQuery);
使用方式是先建立 HTML,引入 jQuery 與外掛,再在 ready 時呼叫:
<script type="text/javascript" src="Scripts/jquery-1.4.1.min.js"></script>
<script type="text/javascript" src="Scripts/jquery.txtHover.js"></script>
<script type="text/javascript">
$(document).ready(function () {
$('#test').txtHover();
});
</script>
</head>
<body>
<div id="test">this is test.</div>
這個版本一載入就把文字換掉了,實用性有限——我們真正想要的是「滑過才變」。
(function ($) {
$.fn.txtHover = function () {
return this.each(function () {
var temp = $(this).text(); // 先把原文存起來
$(this).hover(function () {
$(this).text('text changed!'); // 移入:換字
}, function () {
$(this).text(temp); // 移出:還原
});
});
}
})(jQuery);
把原始文字存在 temp 裡,離開時再寫回去,這樣即使同一頁有多個目標,各自也不會互相污染。
(function ($) {
$.fn.txtHover = function (options) {
var defaults = { txt: 'text changed!' };
var opt = $.extend(defaults, options);
return this.each(function () {
var self = $(this); // 把 this 存下來,避免上下文改變時出錯
var temp = self.text();
self.hover(function () {
self.text(opt.txt);
}, function () {
self.text(temp);
});
});
}
})(jQuery);
呼叫時就能指定要顯示的文字:
$(document).ready(function () {
$('#test').txtHover({ txt: 'test' });
});
$.extend 的合併規則:使用者傳入的物件若有 txt 屬性就覆蓋預設值,沒有就沿用預設。這也是為什麼規範裡說「預設 options 要對外可讀」——後面章節會把 defaults 獨立出來,讓使用者直接改預設值。
為什麼要 var self = $(this):this 在 JavaScript 中會隨函式上下文改變指向,在 each 的內部函式、事件回呼裡往往不是你以為的那個物件。先存成區域變數,是避免這類 bug 最簡單有效的習慣。