data-* 是 HTML5 給開發者預留的「自家人專用」屬性空間。它讓你能把跟呈現無關的資料直接掛在元素上,再用腳本讀寫,在實際專案中非常實用。
基本寫法就是加上前綴:
<div id="user" data-uid="12345" data-uname=""></div>
最直覺的方式是用 attribute 方法存取:
// 取得 data- 屬性
var user = document.getElementById('user');
var userName = user.getAttribute('data-uname'); // userName = ''
var userId = user.getAttribute('data-uid'); // userId = '12345'
// 設定 data- 屬性
user.setAttribute('data-site', 'https://www.example.com');
這招在所有現代瀏覽器都能跑,但它並沒有用到 HTML5 為 data-* 設計的初衷——畢竟如果只是這樣,跟我們以前自己亂取屬性名的差別只在名字長相:
<div id="user" uid="12345" uname=""></div>
<script>
var user = document.getElementById('user');
var userName = user.getAttribute('uname');
var userId = user.getAttribute('uid');
user.setAttribute('site', 'https://www.example.com');
</script>
兩段程式在行為上幾乎等價。差別在於 data-* 有標準背書,也才拿得到下面 dataset 的支援。
透過元素的 dataset 屬性存取 data-* 值。這是 HTML5 JavaScript API 的一部分,會回傳一個包含該元素所有 data 屬性的 DOMStringMap 物件。
使用時要把 data- 前綴去掉。還有一個容易踩到的規則:屬性名若含連字號,例如 data-date-of-birth,存取時要轉成駝峰式命名 dateOfBirth。
<div id="user" data-id="1234567890" data-name="" data-date-of-birth>碼頭</div>
<script type="text/Javascript">
var el = document.querySelector('#user');
console.log(el.id); // 'user'
console.log(el.dataset); // 一個 DOMStringMap
console.log(el.dataset.id); // '1234567890'
console.log(el.dataset.name); // ''
console.log(el.dataset.dateOfBirth); // ''
el.dataset.dateOfBirth = '1985-01-05'; // 設定 data-date-of-birth
console.log('someDataAttr' in el.dataset); // false
el.dataset.someDataAttr = 'mydata';
console.log('someDataAttr' in el.dataset); // true
</script>
要刪除某個 data 屬性,可以寫 delete el.dataset.id; 或 el.dataset.id = null;。
美中不足的是支援度。dataset 在 Chrome 8+、Firefox 6.0+、IE 11+、Opera 11.10+、Safari 6+ 才有;在那之前,getAttribute 與 setAttribute 才是最保險的選擇。(以今日的瀏覽器環境來看,這個顧慮基本已經消失。)
實作時常需要依 data 屬性挑元素,querySelectorAll 就能勝任:
// 選出所有帶有 data-flowering 屬性的元素
document.querySelectorAll('[data-flowering]');
// 選出 data-text-colour 值為 red 的元素
document.querySelectorAll('[data-text-colour="red"]');
CSS 這邊同樣可以直接用屬性選擇器做樣式分流:
<style type="text/CSS">
.user {
width : 256px ;
height : 200px ;
}
.user[data-name='feiwen'] {
color : brown
}
.user[data-name='CSS'] {
color : red
}
</style>
<div class="user" data-id="123" data-name="feiwen">1</div>
<div class="user" data-id="124" data-name="CSS">碼頭</div>
換句話說,data-* 不只是存資料的口袋,它同時是 JavaScript 的資料通道,也是 CSS 的樣式判斷依據。把「這個元素屬於哪一類」寫進 data 屬性,往往比堆一堆 class 更乾淨。