Урок 062 минуты чтения
Что делают data-атрибуты и какая у них задача?
На этой странице
Кратко
data-* атрибуты позволяют хранить пользовательские данные прямо в HTML-разметке. Они полезны для JS-хуков, тестов, идентификаторов и небольших настроек элемента.
Вопрос
Что такое data-атрибуты? Как читать их из JavaScript и CSS и для чего использовать?
Главное
Любой атрибут, начинающийся с data-, считается пользовательским data-атрибутом.
<button
type="button"
data-product-id="42"
data-action="add-to-cart"
>
Купить
</button>Браузер не придает этим данным встроенного смысла, но JavaScript может их читать.
Доступ через dataset
const button = document.querySelector("button");
console.log(button.dataset.productId); // "42"
console.log(button.dataset.action); // "add-to-cart"Имя data-product-id превращается в dataset.productId.
Для чего используют
- Идентификаторы сущностей:
data-user-id,data-product-id. - JS-действия:
data-action. - Тестовые селекторы:
data-test,data-testid. - Небольшие настройки компонентов.
- Интеграции с аналитикой.
<button data-test="save-button" type="submit">
Сохранить
</button>Тестовый селектор не зависит от CSS-классов и текста кнопки.
Чего не стоит делать
Не нужно превращать HTML в базу данных.
<!-- слишком много данных для атрибутов -->
<div data-user='{"id":1,"name":"Анна","roles":["admin"]}'></div>Для сложных данных лучше использовать JavaScript-состояние, JSON-скрипт или API.
Что важно помнить
- Значения
datasetвсегда строки:data-count="5"вернет"5", преобразуйте черезNumber(). - CSS может стилизовать по data-атрибутам (
[data-state="open"]) и выводить значение черезcontent: attr(data-label). - Не храните в data-атрибутах секреты: они видны всем в исходном коде страницы.
- Testing Library рекомендует
data-testidтолько как последний вариант после поиска по роли и тексту.
Мини-шпаргалка
data-*хранит пользовательские данные на элементе.- В JS доступен через
element.dataset. data-product-idстановитсяdataset.productId.- Удобен для тестов и небольших JS-хуков.
- Не стоит хранить в data-атрибутах большие сложные объекты.
Документация
MDN: Использование data-атрибутов, MDN: HTMLElement.dataset.
Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.