這份指南以實例為主線,一步步說明 jQuery 的運作方式:從安裝、選取器與事件,一路走到 AJAX、動畫效果,最後自己動手做一個插件。適合已經具備基本 HTML(DOM)與 CSS 概念、卻還沒正式寫過 jQuery 的讀者。
先下載 jQuery 程式庫,建議再取一份官方提供的 Starterkit 範例包。解壓後用慣用的編輯器打開 starterkit.html 與 custom.js:所有練習都在這兩個檔案裡進行,jQuery 程式碼寫在 custom.js,效果在瀏覽器開 starterkit.html 觀察。光看文章不實作,是學不会的。
學習期間建議長期開著兩份 API 文件隨時查:官方 API 手冊與可分類瀏覽的 Visual jQuery。
所有操作都應該等 DOM 就緒之後才執行,因此起手式永遠是 ready:
$(document).ready(function() {
// DOM 準備好之後要做的事
});
把 alert 放進去試試,再升級成「點擊任何一個連結就跳出一句問候」:
$(document).ready(function() {
$("a").click(function() {
alert("Hello world!");
});
});
拆解這三行程式:$("a") 是一個 jQuery 選擇器,選出頁面上所有的 a 標籤;$ 是 jQuery 物件(類)的別名,$() 因此是在建立一個新的 jQuery 物件;click() 是這個物件的方法,負責把單擊事件綁定到所有選中的元素上。
等價的原生寫法長這樣:
<a href="#" onclick="alert('Hello world')">Link</a>
差別很明顯:不必在每個標籤上寫 onclick,結構(HTML)與行為(JS)得以分離,這正是 CSS 分離樣式時追求的同一種精神。
jQuery 提供兩種選取元素的方式,而且可以混用:一是把 CSS/XPath 風格的字串傳進 jQuery 建構子,例如 $("div > ul a");二是使用 jQuery 物件上的方法。
先替第一個有序列表加上樣式:
$(document).ready(function() {
$("#orderedlist").addClass("red");
});
再往下鑽一層,只處理它的子元素:
$(document).ready(function() {
$("#orderedlist > li").addClass("blue");
});
接著做滑鼠移入移出的樣式切換,而且只對最後一個項目生效:
$(document).ready(function() {
$("#orderedlist li:last").hover(function() {
$(this).addClass("green");
}, function() {
$(this).removeClass("green");
});
});
幾乎所有 onXXX 事件都有對應方法,只是把 on 拿掉:onclick 變成 click()、onchange 變成 change()、onsubmit 變成 submit()。此外 ready、hover 這類「非原生」事件也各自提供了專用方法。
$(document).ready(function() {
$("#orderedlist").find("li").each(function(i) {
$(this).html($(this).html() + " BAM! " + i);
});
});
find() 讓你在既有結果中做條件查找,效果等同 $("#orderedlist li");each() 則逐一迭代。注意 html() 用來「取得」元素的 HTML 內容,html('xxx') 才是「設定」。大多數方法(如 addClass())內部都已經幫你做過 each。
有些原生方法不在 jQuery 的包裝範圍內,這時可以用索引取出真正的 DOM 節點再呼叫:
$("#reset").click(function() {
$("#form")[0].reset(); // 只重設單一個表單
});
$("#reset").click(function() {
$("form").each(function() {
this.reset(); // 重設所有表單
});
});
想「排除」某些元素時,用 not() 或 filter():
$("li").not("[ul]").css("border", "1px solid black");
這段程式選出所有 li,再剔除含有 ul 子元素的那些。順帶留意 css() 有多好用,而且可以串接:$("li").not("[ul]").css("border","1px solid black").css("color","red");
方括號語法源自 XPath,可用來過濾元素與屬性,例如選出所有帶 name 屬性的連結:$("a[@name]");或用部分比對 *= 應付各瀏覽器對 href 解讀不一致的問題:
$("a[@href*=/content/gallery]").click(function() {
// 對所有指向 /content/gallery 的連結做事
});
FAQ 收合是最經典的例子:答案先隱藏,點問題才展開。
$(document).ready(function() {
$('#faq').find('dd').hide().end().find('dt').click(function() {
var answer = $(this).next();
if (answer.is(':visible')) {
answer.slideUp();
} else {
answer.slideDown();
}
});
});
這裡用了鏈式表達:#faq 只選一次,end() 把前一次 find() 還原,於是後面可以直接接 find('dt')。$(this).next() 則拿到緊接在後的 dd,也就是被點問題的答案。
反方向選父元素同樣容易:
$("a").hover(function() {
$(this).parents("p").addClass("highlight");
}, function() {
$(this).parents("p").removeClass("highlight");
});
最後記得這個縮寫:$(document).ready(callback) 可以寫成 $(function(){ ... }),於是 Hello World 變成:
$(function() {
$("a").click(function() { alert("Hello world!"); });
});
這個範例做出一個五顆星的投票元件,行為類似影片網站上的評分功能。伺服器端以 PHP 接收 rating 參數,回傳 XML 格式的平均分數與投票數。
$(document).ready(function() {
// 動態產生介面
var ratingMarkup = ["Please rate: "];
for (var i = 1; i <= 5; i++) {
ratingMarkup[ratingMarkup.length] = "<a href='#'>" + i + "</a> ";
}
$("#rating").append(ratingMarkup.join('')).find("a").click(function(e) {
e.preventDefault();
$.post("rate.php", { rating: $(this).html() }, function(xml) {
var result = [
"Thanks for rating, current average: ", $("average", xml).text(),
", number of votes: ", $("count", xml).text()
];
$("#rating").html(result.join(''));
});
});
});
點其中任一連結時,分數會以 rating 參數送到 rate.php,回傳的 XML 再被解析並覆寫容器內容,把那些連結換成結果。實作時可以再加 loading 提示、允許重複投票等細節。
一、載入後的事件要重新綁定。用 AJAX 塞進來的 HTML,原本的事件並不存在,需要在其載入完成後再掛一次。把綁定邏輯抽成函式,並作為 load() 的回呼傳入,就能避免重複執行:
$(function() {
var addClickHandlers = function() {
$("a.clickMeToLoadContent").click(function() {
$("#target").load(this.href, addClickHandlers);
});
};
addClickHandlers();
});
刻意把它定義成區域變數而非全域函式,是為了避免與其他全域名稱碰撞。
二、回呼函式要帶參數。把回呼包進另一個匿名函式裡傳值;若同時需要原本的 this 語境,改用 apply:
var foobar = ...;
var handler = function(data) { ... };
$('a').click(function(event) { handler(foobar); });
$('a').click(function(event) { handler.apply(this, [foobar]); });
最簡單的動態效果來自 show() 與 hide():
$(document).ready(function() {
$("a").toggle(function() {
$(".stuff").hide('slow');
}, function() {
$(".stuff").show('fast');
});
});
搭配 animate() 就能做出滑動加淡出的複合效果:
$("a").toggle(function() {
$(".stuff").animate({ height: 'hide', opacity: 'hide' }, 'slow');
}, function() {
$(".stuff").animate({ height: 'show', opacity: 'show' }, 'slow');
});
需要更多變化時,可以參考 Interface 這類效果插件集合,裡面有大量 demo 與文件。
表格排序插件讓排序在瀏覽器端完成。先引入 jQuery 與插件:
<script src="lib/jquery.tablesorter.js" type="text/javascript"></script>
再告訴它哪個表格要排序:
$(document).ready(function() {
$("#large").tableSorter();
});
點表頭即可排序,再點一次反向排列。加上參數還能做出斑馬線:
$("#large").tableSorter({
stripingRowClass: ['odd', 'even'],
stripRowsOnStartUp: true
});
幾乎所有插件都是同一套用法:include 插件的 js,然後在目標元素上呼叫插件方法,必要的話再傳入選項。
把常用程式碼打包成插件,方便團隊或他人重用。撰寫時建議遵守幾個約定:
foobar。jquery.[插件名].js,例如 jquery.foobar.js。jQuery.fn.foobar = function() { /* do something */ };
jQuery.foobar = {
height: 5,
calculateBar: function() { ... },
checkDependencies: function() { ... }
};
jQuery.fn.foobar = function(options) {
var settings = { value: 5, name: "pete", bar: 655 };
if (options) { jQuery.extend(settings, options); }
};
於是 $("...").foobar() 用預設值,$("...").foobar({ value: 123, bar: 9 }) 則自訂。
要發布插件,別忘了附上範例與文件。
很多人寫過這種code:
$("input[@type='checkbox']").each(function() {
this.checked = true; // 或 false 取消,或 !this.checked 反轉
});
只要程式裡出現 each,就該考慮重寫成插件:
$.fn.check = function() {
return this.each(function() { this.checked = true; });
};
現在可以寫成 $("input[@type='checkbox']").check();。再加個參數就能一次涵蓋三種行為:
$.fn.check = function(mode) {
var mode = mode || 'on'; // 未傳入時預設 'on'
return this.each(function() {
switch (mode) {
case 'on': this.checked = true; break;
case 'off': this.checked = false; break;
case 'toggle': this.checked = !this.checked; break;
}
});
};
參數超過一個時會稍微複雜:若只想設定第二個參數,第一個位置要填 null。也可以像 tablesorter 那樣,全部省略或用 key/value 一組組覆寫。
把上一節的評分功能改寫成插件,骨架大致如下:
$.fn.rateMe = function(options) {
var container = this; // 不再寫死 $("#rating"),改用目前的 jQuery 語境
var settings = { url: "rate.php" }; // 記得每組之後加逗號,最後一組不加
if (options) { $.extend(settings, options); }
// ...其餘程式...
return this; // 盡量回傳 this,才不會破壞鏈式呼叫
};
想做更嚴謹的 JavaScript 開發,強烈建議裝上 Firefox 的 FireBug:中斷點除錯比 alert 好用太多,還能觀察 DOM 變化。遇到卡關或想提建議,jQuery 官方郵件列表與作者的部落格都是好去處。
最後,感謝 John Resig 創造了這麼好用的函式庫,也感謝社群一路以來的支援。