浏览器与 Web API / 系统课时

dataset 与自定义数据属性

dataset 与自定义数据属性

本课解决如何把业务标识、状态或配置安全地挂在 HTML 元素上,并通过 dataset 读取、修改和删除这些值。完成后,你能正确处理 data-* 与驼峰属性名之间的转换,也能避开字符串类型带来的常见判断错误。

学习目标

  • 使用 data-* 为元素保存自定义数据
  • 掌握属性名与 dataset 属性名的转换规则
  • 正确读写、删除并转换 dataset 中的字符串值

data-* 与 dataset 的对应关系

HTML 允许使用以 data- 开头的自定义属性,例如 data-user-id。浏览器会把这些属性映射到元素的 dataset 对象中,因此 JavaScript 可以通过 element.dataset.userId 访问它们,而不必调用通用属性接口。

data-* 与 dataset 的命名映射

命名转换有两个方向:HTML 到 JavaScript 时去掉 data-,并把连字符后的字母改为大写,例如 data-order-id 变为 dataset.orderId;JavaScript 到 HTML 时,大写字母会转为“连字符加小写字母”,例如 dataset.isVip 对应 data-is-vip。

属性名应使用小写字母、数字和连字符。像 data-user--id 这类连续连字符虽然可能被浏览器保留,但映射结果不直观,不适合作为团队约定。

完整读写示例

下面的代码可直接在浏览器控制台执行。它创建一个课程卡片,读取初始数据,再修改状态、增加进度并删除旧标识。

js
document.body.innerHTML = `
  <article id="course" data-course-id="dom-101" data-status="draft">
    HTML DOM 编程
  </article>
`;

const course = document.querySelector("#course");

// 读取时使用驼峰属性名,返回值均为字符串
console.log(course.dataset.courseId);
console.log(course.dataset.status);

// 修改 dataset 会同步更新对应的 data-* 属性
course.dataset.status = "published";
course.dataset.progress = 80;
delete course.dataset.courseId;

console.log(course.dataset.status);
console.log(course.dataset.progress);
console.log(course.hasAttribute("data-course-id"));
console.log(course.outerHTML);

预期输出:

text
dom-101
draft
published
80
false
<article id="course" data-status="published" data-progress="80">
    HTML DOM 编程
  </article>

outerHTML 中的缩进和换行可能因浏览器序列化方式略有不同,但属性变化应一致:data-status 被更新,data-progress 被创建,data-course-id 被删除。

类型转换与操作边界

无论 HTML 中看起来像数字、布尔值还是 JSON,dataset 返回的都是字符串。写入数字 80 时,DOM 中最终保存的也是 "80"。字符串 "false" 仍然是真值,因此读取后应按业务类型显式转换。

js
const panel = document.createElement("section");
panel.dataset.count = "12";
panel.dataset.enabled = "false";

// 根据字段含义显式转换,而不是依赖字符串真假
const count = Number(panel.dataset.count);
const enabled = panel.dataset.enabled === "true";

console.log(count + 1);
console.log(enabled);

预期输出:

text
13
false

判断属性是否存在时,可使用 "status" in element.dataset 或 element.hasAttribute("data-status")。删除数据应使用 delete element.dataset.status;赋值为 null 只会得到字符串 "null",不会移除属性。

结构化数据可以先用 JSON.stringify() 写入,再用 JSON.parse() 还原,但不应把大量业务状态塞进 DOM。复杂状态更适合保存在 JavaScript 对象中,元素只保留查询、关联或交互所需的少量数据。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

dataset 与自定义数据属性

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通