寫 jQuery 時最耗時的往往不是邏輯,而是「這個方法到底叫什麼名字」。以下把常用 API 依功能分類整理成速查表,搭配說明欄位,方便隨手翻查。
一、選擇器
| 選擇符 | 匹配對象 |
* | 所有元素 |
#id | 帶有給定 ID 的元素 |
element | 給定類型的所有元素,例如 HTML 標籤 |
.class | 帶有給定類的所有元素 |
a, b | 匹配 a 或匹配 b 的元素 |
a b | 作為 a 後代的匹配 b 的元素(含孫輩) |
a > b | 作為 a 直接子元素的匹配 b 的元素(只含兒子輩) |
:first | 結果集中的第一個元素 |
:last | 結果集中的最後一個元素 |
:not(a) | 結果集中與 a 不匹配的所有元素 |
:even | 結果集中的偶數元素(從 0 開始計數) |
:odd | 結果集中的奇數元素(從 0 開始計數) |
:eq(index) | 結果集中索引為 index 的元素(從 0 起算) |
:gt(index) | 結果集中位於給定索引之後的所有元素 |
:lt(index) | 結果集中位於給定索引之前的所有元素 |
:header | 標題元素(h1、h2 等) |
:animated | 其動畫正在播放的元素 |
:contains(text) | 包含給定文字 text 的元素 |
:empty | 不包含子節點的元素 |
:has(a) | 後代元素中至少有一個匹配 a 的元素 |
:parent | 含有子節點或文字的元素 |
:hidden | 隱藏的元素,含 CSS 隱藏與 <input type="hidden"> |
:visible | 與 :hidden 相反 |
[attr] | 帶有屬性 attr 的元素 |
[attr=value] | attr 屬性的值為 value 的元素 |
[attr!=value] | attr 屬性的值不為 value 的元素 |
[attr^=value] | attr 屬性的值以 value 開頭 |
[attr$=value] | attr 屬性的值以 value 結尾 |
[attr*=value] | attr 屬性的值包含字串 value |
:nth-child(index) | 每個元素集合中的第 index 個子元素(從 1 起算) |
:nth-child(even) | 每個父元素中排在偶數位的子元素 |
:nth-child(odd) | 每個父元素中排在奇數位的子元素 |
:nth-child(formula) | 公式格式為 an+b,a、b 為整數 |
:first-child | 每個父元素下的第一個子元素 |
:last-child | 每個父元素下的最後一個子元素 |
:only-child | 父元素下唯一的子元素,不唯一則不執行 |
:input | 所有 input、select、textarea 和 button 元素 |
:text | type="text" 的 input 元素 |
:password | type="password" 的 input 元素 |
:radio | type="radio" 的 input 元素 |
:checkbox | type="checkbox" 的 input 元素 |
:submit | type="submit" 的 input 元素 |
:image | type="image" 的 input 元素 |
:reset | type="reset" 的 input 元素 |
:button | type="button" 的 input 元素及 button 元素 |
:file | type="file" 的 input 元素 |
:enabled | 啟用的表單元素 |
:disabled | 停用的表單元素 |
:checked | 選中的 checkbox 和 radio 元素 |
:selected | 選中的 option 元素 |
二、走訪方法
| 方法 | 回傳的 jQuery 物件包含 |
.filter(selector) | 與給定選擇符匹配的選中元素 |
.filter(callback) | 回呼函式 callback 回傳 true 的選中元素 |
.eq(index) | 從 0 開始計數的第 index 個選中元素 |
.slice(start,[end]) | 從 0 起算的給定範圍內的選中元素 |
.not(selector) | 與給定選擇符不匹配的選中元素 |
.add(selector) | 選中元素再加上與選擇符匹配的元素 |
.find(selector) | 與選擇符匹配的後代元素 |
.contents() | 子節點,包含文字節點 |
.children([selector]) | 匹配選擇符的直接子節點 |
.next([selector]) | 每個選中元素的下一個匹配同輩元素 |
.nextAll([selector]) | 每個選中元素之後的所有匹配同輩元素 |
.prev([selector]) | 每個選中元素的上一個匹配同輩元素 |
.prevAll([selector]) | 每個選中元素之前的所有匹配同輩元素 |
.siblings([selector]) | 匹配選擇符的所有同輩元素 |
.parent([selector]) | 每個選中元素的匹配父元素 |
.parents([selector]) | 每個選中元素的匹配的所有祖先元素 |
.offsetParent() | 第一個選中元素被定位的父元素(relative 或 absolute) |
.andSelf() | 選中元素再加上內部 jQuery 堆疊中之前選中的元素 |
.end() | 內部 jQuery 堆疊中之前選中的元素 |
.map(callback) | 對每個選中元素呼叫 callback 後的結果 |
三、事件方法
| 方法 | 說明 |
.ready(fun) | 綁定在 DOM 與 CSS 完全載入後呼叫的處理器 |
.bind(type,[data],fun) | 綁定指定類型事件送到元素時呼叫的處理器 |
.one(type,[data],fun) | 同上,但 fun 只執行一次 |
.unbind(type,[fun]) | 解除元素上綁定的處理器 |
.live(type,fun) | 綁定事件處理器,動態產生的元素也適用 |
.die(type,[fun]) | 移除先前透過 live() 綁定的處理器 |
.blur(fun) | 失去焦點事件 |
.change(fun) | 目前值改變事件 |
.click(fun) | 點擊事件 |
.dbclick(fun) | 雙擊事件 |
.error(fun) | 錯誤事件 |
.focus(fun) | 取得鍵盤焦點事件 |
.keydown(fun) | 取得焦點且有鍵被按下 |
.keypress(fun) | 取得焦點且有按鍵事件發生 |
.keyup(fun) | 取得焦點且有鍵被釋放 |
.load(fun) | 元素載入完成事件 |
.mousedown(fun) | 按下滑鼠鍵事件 |
.mouseenter(fun) | 滑鼠進入元素,不受事件冒泡影響 |
.mouseleave(fun) | 滑鼠離開元素,不受事件冒泡影響 |
.mousemove(fun) | 移動滑鼠指標事件 |
.mouseout(fun) | 滑鼠指標離開事件 |
.mouseover(fun) | 滑鼠指標進入事件 |
.mouseup(fun) | 釋放滑鼠鍵事件 |
.resize(fun) | 調整元素大小事件 |
.scroll(fun) | 元素捲動位置改變事件 |
.select(fun) | 文字被選中事件 |
.submit(fun) | 提交事件 |
.unload(fun) | 元素從記憶體卸載後呼叫 |
.hover(enter,leave) | 進入執行 enter,離開執行 leave |
.toggle(fun1,fun2) | 順序執行事件,來回循環 |
.trigger(type,[data]) | 觸發元素事件,並執行該事件的預設操作 |
.triggerHandler(type,[data]) | 觸發元素事件,不執行預設操作 |
此外,.blur()、.change()、.click()、.dbclick()、.error()、.focus()、.keydown()、.keypress()、.keyup()、.select()、.submit() 這些不帶參數呼叫時,作用是「觸發」對應事件。
四、效果方法
| 方法 | 說明 |
.show() / .hide() | 顯示 / 隱藏 |
.show(speed,[callback]) | 以指定速度顯示 |
.hide(speed,[callback]) | 以指定速度隱藏 |
.toggle(speed,[callback]) | 顯示或隱藏切換 |
.slideDown(speed,[callback]) | 滑入顯示 |
.slideUp(speed,[callback]) | 滑出隱藏 |
.slideToggle(speed,[callback]) | 滑動顯示或隱藏 |
.fadeIn(speed,[callback]) | 淡入顯示 |
.fadeOut(speed,[callback]) | 淡出隱藏 |
.fadeTo(speed,opacity,[callback]) | 調整元素的不透明度 |
.animate(attr,[speed],[easing]) | 針對指定的 CSS 屬性執行自定義動畫 |
.animate(attr,options) | 動畫佇列寫法 |
.stop([clearQueue],[jumpToEnd]) | 停止當前動畫,可選擇是否啟動排列中的動畫 |
.queue() | 取得第一個匹配元素上的動畫佇列 |
.queue(callback) | 在動畫佇列最後添加函式 |
.queue(newQueue) | 新佇列取代原佇列 |
.dequeue() | 執行佇列中的下一個動畫 |
五、屬性與 CSS 操作
| 方法 | 說明 |
.attr(key) | 取得屬性 key 的值 |
.attr(key,value) | 設定屬性 key 的值為 value |
.attr(key,fun) | 設定屬性 key 的值為 fun 函式的回傳值 |
.attr(map) | 依傳入的鍵值對設定多個屬性 |
.removeAttr(key) | 移除屬性 key |
.addClass(class) | 添加 CSS 樣式類 |
.removeClass(class) | 移除 CSS 樣式類 |
.toggleClass(class) | 不存在就添加,存在就刪除 |
.hasClass(class) | 至少有一個元素包含該類時回傳 true |
.html() | 取得第一個匹配元素的 HTML 內容 |
.html(value) | 將每個匹配元素的 HTML 內容設為 value |
.text() | 取得所有匹配元素合併後的文字內容 |
.text(value) | 設定每個匹配元素的文字內容為 value |
.val() | 取得第一個匹配元素的 value 屬性值 |
.val(value) | 設定每個匹配元素的 value 為傳入值 |
.css(key) | 取得 CSS 屬性 key 的值 |
.css(key,value) | 設定 CSS 屬性 key 的值 |
.css(map) | 依傳入的鍵值對設定多個 CSS 屬性 |
.offset() | 取得第一個匹配元素相對於視口的左上座標(像素) |
.position() | 取得第一個匹配元素相對於 offsetParent() 的左上座標 |
.scrollTop() | 取得第一個匹配元素的垂直捲動位置 |
.scrollTop(value) | 設定垂直捲動位置為 value |
.scrollLeft() | 取得第一個匹配元素的水準捲動位置 |
.scrollLeft(value) | 設定水準捲動位置為 value |
.height() / .width() | 取得第一個匹配元素的高度 / 寬度 |
.height(value) / .width(value) | 設定高度 / 寬度為 value |
.innerHeight() / .innerWidth() | 包含內距但不含邊框的高度 / 寬度 |
.outerHeight(includeMargin) | 包含內距、邊框及可選外距的高度 |
.outerWidth(includeMargin) | 包含內距、邊框及可選外距的寬度 |
六、DOM 節點操作
| 方法 | 說明 |
.append(content) | 在每個匹配元素內部的末尾插入 content |
.appendTo(selector) | 將匹配元素插入到 selector 匹配元素內部的末尾 |
.prepend(content) | 在每個匹配元素內部的開頭插入 content |
.prependTo(selector) | 將匹配元素插入到 selector 匹配元素內部的開頭 |
.after(content) | 在每個匹配元素的後面插入 content |
.insertAfter(selector) | 將匹配元素插入到 selector 匹配元素的後面 |
.before(content) | 在每個匹配元素的前面插入 content |
.insertBefore(selector) | 將匹配元素插入到 selector 匹配元素的前面 |
.wrap(content) | 將匹配的每個元素各自包裝在 content 中 |
.wrapAll(content) | 將匹配的所有元素作為一個單元包裝在 content 中 |
.wrapInner(content) | 將匹配的每個元素內部的內容包裝在 content 中 |
.unwrap() | 移除匹配元素的父層容器 |
.replaceWith(content) | 將匹配的元素替換成 content |
.replaceAll(selector) | 將 selector 匹配的元素替換成匹配的元素 |
.empty() | 移除每個匹配元素的子節點 |
.remove([selector]) | 從 DOM 中移除匹配節點,可用 selector 篩選 |
.clone([withHandlers]) | 回傳所有匹配元素的副本 |
.data(key) | 取得與第一個匹配元素關聯的 key 資料項 |
.data(key,value) | 設定與每個匹配元素關聯的 key 資料項為 value |
.removeData(key) | 移除與每個匹配元素關聯的 key 資料項 |
七、Ajax 方法
| 方法 | 說明 |
$.ajax(options) | 使用傳入的 options 發出一次 Ajax 請求 |
.load(url,[data],[callback]) | 向 url 發出請求,並將回應放入匹配元素 |
$.get(url,[data],[callback],[returnType]) | 使用 GET 方法發出請求 |
$.post(url,[data],[callback],[returnType]) | 使用 POST 方法發出請求 |
$.getJSON(url,[data],[callback]) | 發出請求並將回應解析為 JSON 資料結構 |
$.getScript(url,[callback]) | 發出請求並將回應作為 JS 腳本執行 |
.ajaxComplete(handler) | 任意 Ajax 事務完成後呼叫 |
.ajaxError(handler) | 任意 Ajax 事務發生錯誤時呼叫 |
.ajaxSend(handler) | 任意 Ajax 事務開始時呼叫 |
.ajaxStart(handler) | 第一個 Ajax 事務開始、且無其他事務活動時呼叫 |
.ajaxStop(handler) | 最後一個 Ajax 事務結束、且無其他事務活動時呼叫 |
.ajaxSuccess(handler) | 任意 Ajax 事務成功完成時呼叫 |
$.ajaxSetup(options) | 為後續的 Ajax 事務設定預設選項 |
.serialize() | 將一組表單控件的值編碼為查詢字串 |
.serializeArray() | 將一組表單控件的值編碼為 JSON 資料結構 |
$.param(map) | 將任意值的映射編碼為查詢字串 |
八、工具方法與屬性
| 方法或屬性 | 說明 |
$.support | 回傳屬性映射,表示瀏覽器是否支援各種特性與標準 |
$.each(collection,callback) | 迭代走訪集合,針對每一項執行回呼 |
$.extend(target,addition,...) | 擴展 target 物件,把後續物件的屬性併入 |
$.makeArray(object) | 將物件轉換為陣列 |
$.map(array,callback) | 針對陣列每一項執行回呼,回傳新陣列 |
$.inArray(value,array) | 判斷陣列中是否包含值 value |
$.merge(array1,array2) | 合併兩個陣列 |
$.unique(array) | 從陣列中移除重複的 DOM 元素 |
$.isFunction(object) | 判斷物件是否為函式 |
$.trim(String) | 移除字串兩端的空白符 |
$.noConflict([extreme]) | 讓出 $ 符號使用權,恢復使用 jQuery 標識符 |
.hasClass(className) | 判斷匹配元素是否包含給定的類 |
.is(selector) | 判斷是否有匹配元素符合給定的選擇符運算式 |
.each(callback) | 迭代走訪匹配元素,針對每個元素執行回呼 |
.length | 取得匹配元素的個數 |
.get() | 取得與匹配元素對應的 DOM 節點陣列 |
.get(index) | 取得匹配元素中與傳入索引對應的 DOM 節點 |
.index(element) | 取得給定 DOM 節點在匹配元素集合中的索引值 |
使用這份速查表的三個提醒
一、注意版本差異。.live() 與 .die() 自 jQuery 1.9 起已移除,改用 .on() 與 .off() 搭配事件委派:$(document).on("click", ".btn", handler)。
二、注意索引起算點。:eq()、:even、:odd、.eq() 從 0 起算;:nth-child()、:first-child 從 1 起算。
三、注意讀寫語意。表中大量方法(attr、css、html、text、val、height、width、scrollTop)都遵循同一規則:不帶參數是讀取,帶參數是設定。記住這點,半數的 API 都不用背。