attr() 是操作元素屬性的萬用鑰匙,但它有四種不同的呼叫形式,各自回傳值與作用範圍都不同。以下逐一示範,最後再談 removeAttr()。
參數 name 為字串。若元素沒有該屬性,回傳 undefined。
// HTML:<img src="a.gif" />
$(function(){
var imgSrc = $("img").attr('src');
alert(imgSrc); // 顯示 a.gif
})
注意它只回傳第一個元素的屬性,這與 jQuery 多數「取值取第一個、設值設全部」的慣例一致。
// HTML:<img />
$(function(){
$("img").attr('src', 'a.gif');
})
// 結果:<img src="a.gif" />
這是在所有符合元素上設定多個屬性的最佳方式。要設定 class 屬性時,必須使用 className 作為屬性名,或者直接使用 .addClass(class) 與 .removeClass(class)。
// HTML:<img />
$(function(){
$("img").attr({
src: 'a.gif',
title: 'this is a image',
className: 'filter'
});
})
// 結果:<img src="a.gif" title="this is a image" class="filter">
為什麼是 className 而不是 class?因為 class 是 JavaScript 的保留字,早期瀏覽器在屬性映射時無法直接使用,因此沿用了 DOM 的 className 命名。
不提供固定值,而是提供一個函式,由它計算後回傳的值作為屬性值。函式中的 this 指向目前的元素。
// HTML:<img src="a.gif" />
$(function(){
$("img").attr('title', function(){ return this.src });
})
// 結果:<img src="a.gif" title="a.gif" />
這個形式在「屬性值要依每個元素而異」時特別好用,例如依序編號:$("li").attr("data-index", function(i){ return i; });
// HTML:<img src="a.gif" title="this is a image" ?>
$(function(){
$("img").removeAttr('title');
})
// 結果:<img src="a.gif" />
這是最實際的問題。從 jQuery 1.6 起,官方把「HTML 屬性」與「DOM property」拆成兩組 API:
attr():操作會反映到 HTML 標籤上的屬性,例如 src、title、data-*、aria-*、id、class。prop():操作元素的「當前狀態」,例如 checked、selected、disabled,以及 tagName 這類純 DOM 屬性。實務上最常踩的坑就是 checkbox:$("#chk").attr("checked", true) 只改變了 HTML 上的初始屬性,勾選狀態不會更新,應改用 $("#chk").prop("checked", true)。同理,removeAttr("disabled") 在部分情況下不如 prop("disabled", false) 可靠。
以上四種 attr() 形式加上 removeAttr() 已涵蓋日常九成以上的情境,剩下的複雜應用,掌握了基本用法之後多試幾次就能上手。