DIV CSS 佈局教程網

用 jQuery 讀寫 HTML5 data-* 自訂屬性完整教學
編輯:JQuery特效代碼     

HTML5 的 data-* 自訂屬性,解決了「想在標籤上塞一點自己的資料,卻沒有合法位置可放」的長年困擾。過去的解法是硬塞 rel、title 或自創屬性再靠瀏覽器睜一隻眼閉一隻眼,更糟的是讓 validator 滿江紅。

規格怎麼說

規則非常寬鬆:你可以在任何元素上加任意個以 data- 開頭的屬性,值必須是字串。這些屬性不會顯示在畫面上,不影響版面與樣式,但 JavaScript 完全可以讀寫。它們最適合存放「與呈現無關、但行為需要」的資訊,例如項目 id、資料索引、狀態旗標。

jQuery 的支援

jQuery 自 1.4.3 起內建 .data(),能直接對應到 data-* 屬性,並自動把字串轉為適當型別(數字變 number、true 變布林、JSON 字串變物件):

$('#content').data('list');

注意命名轉換:HTML 上的 data-user-name,在 JavaScript 中要寫成 .data('userName'),連字號後的首字母會被駝峰化。

完整範例

<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
<title>jQuery 操作 data-* 屬性</title>
<script src="https://code.jquery.com/jquery-2.1.0.min.js"></script>
<script>
$(function () {
    // 讀取
    $("li").each(function () {
        console.log($(this).data('name'));
    });

    // 設定
    $("li").eq(0).data('name', 'bryant');
    $("li").each(function () {
        console.log($(this).data('name'));
    });

    // 刪除:實測 removeData 未必能還原 HTML 屬性,這裡用 removeAttr
    $("li").eq(0).removeAttr('data-name');
    $("li").each(function () {
        console.log($(this).data('name'));
    });
});
</script>
</head>
<body>
<ul>
  <li data-name="kobe">科比</li>
  <li data-name="gasol">加索爾</li>
  <li data-name="nash">納什</li>
  <li data-name="fisher">費捨爾</li>
</ul>
</body>
</html>

一個必須知道的陷阱

.data() 設定的值存在 jQuery 的內部快取,不會寫回 HTML 屬性。也就是說 $("li").eq(0).data('name','bryant') 之後,用 devtools 檢查 DOM 是看不到 data-name 變化的。這帶來兩個後果:

  • 用 removeAttr('data-name') 刪不掉透過 .data() 寫入的值,這正是原範例註解所遇到的現象。正解是 removeData('name')。
  • 反過來說,.data() 讀值時會先看內部快取,再看 HTML 屬性。若你希望「改寫後能反映到 DOM 上供他人讀取」,應該改用 .attr('data-name', 'bryant')。

實務上的判斷很簡單:需要跨元件或跨程式庫共享、或要能被 CSS 選擇器選中,用 attr();純粹自己腳本內部暫存,用 data()。

現代寫法

若不依賴 jQuery,原生 API 其實更乾淨:

var el = document.querySelector('li');
el.dataset.name;              // 讀取
el.dataset.name = 'bryant';   // 設定(會同步反映到 HTML)
delete el.dataset.name;       // 刪除
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved