寫 $("input").attr("checked","checked") 之後,checkbox 卻沒有真的被勾選起來,這是許多人升級 jQuery 後遇到的第一個大坑。
用 Chrome 開發者工具檢查,DOM 上確實出現了 checked 屬性且值為 checked,但畫面上核取方塊仍是未勾選的狀態。
$("input").prop("checked", true);
關鍵在於 HTML 的 attribute(屬性)與 DOM 物件的 property(特性)是兩回事:
.attr() 回傳 HTML 屬性的值,.prop() 回傳 DOM 特性的值。.attr() 在取某些值時會「順便」回傳 property,造成結果不一致。核取方塊的 checked 狀態屬於 property,所以必須用 prop() 操作。以下屬性也同樣建議改用 prop():selectedIndex、tagName、nodeName、nodeType、ownerDocument、defaultChecked、defaultSelected。
考慮以下 HTML:
<input type="checkbox" checked="checked" />
假設它是 JS 變數 elem,各寫法的行為如下:
elem.checked // true (Boolean),會改變核取方塊狀態
$(elem).prop("checked") // true (Boolean),會改變核取方塊狀態
elem.getAttribute("checked") // "checked" (String),不會改變核取方塊的目前狀態
$(elem).attr("checked") (1.6) // "checked" (String),不會改變狀態
$(elem).attr("checked") (1.6.1+) // "checked" (String),會改變狀態
$(elem).attr("checked") (pre-1.6)// true (Boolean),會改變狀態
在 HTML 表單規範中,checked 是布林屬性,代表只要這個 attribute 存在,不論有沒有值、甚至值是空字串,對應的 property 就是 true。因此 attr("checked") 讀到的其實是「初始的預設值」,而非「目前的狀態」。
if ( elem.checked ) // 純原生,最直覺
if ( $(elem).prop("checked") ) // jQuery 屬性方式
if ( $(elem).is(":checked") ) // jQuery 選擇器方式
這三種都能正確反映目前狀態,任選一種並在專案內統一即可。若使用 jQuery 1.6,if ($(elem).attr("checked")) 會拿到屬性字串,無法正確代表勾選與否,應避免。
好消息是為了向後相容,.attr() 從 1.6.1 起除了回傳屬性值,也會同步更新 property,因此布林屬性的設定往往用 attr 也能生效——但讀取狀態時仍強烈建議用 prop() 或 is(":checked"),語意清楚又不受版本影響。