javascript – Best practice: class or data attribute as identifier-ThrowExceptions

Exception or error:

Lately I’ve been wondering what the best way to go is to perform javascript actions on multiple elements.

The way I see it there are 2 possibilities:

  • Either I add a css class to my elements, which doesn’t necessarily correspond to any existing css rules: <div class="validation-required"></div>
  • Or I use a data-attribute like so: <div data-validation-required></div>

In my IDE (Visual studio 2012 using R#), if I use the first method, I get a warning saying I shouldn’t use css-classes which aren’t defined. Which makes me believe this might not be the best idea anyway. However, this is the method I’ve most-often seen used, though this might just be a relic from days before we could use the data- attribute.

So my question is pretty simple, which way should I go to simply “tag” an element for further processing?

Thanks for any answers

PS: I realize this question might be prone to subjective opinions, though I do hope there is a concensus on what to use in modern-day browsers.

PPS: I’ve done a search on this matter, but most questions are about performance, which isn’t my primary concern for one-off situations.

How to solve:

According to W3C

data-*

Custom data attributes are intended to store custom data private to the page or application, for which there are no more appropriate attributes or elements.
These attributes are not intended for use by software that is independent of the site that uses the attributes.

class

The class attribute has several roles in HTML: As a style sheet selector (when an author wishes to assign style information to a set of elements). For general purpose processing by user agents.

If you use class attribute, you can benefit from native getElementsByClassName searching and classList object for toggling, adding and removing class. There’s nothing like getElementsByAttributeValue. There is relatively slower Element.querySelectorAll([data-attr=”value”]) See Oliver Moran’s comment

On the other hand, if you need to store multiple data, you can use dataset attribute.

So if you want searching or if the data affect the look of the element, I would use class. If you need to store multiple data, the data would be more appropriate.

###

If you merely want to associate “values” to DOM elements for computational purposes then data-attribute is the way to go since,

anything that is “data-” will be treated as a storage area for private
data (private in the sense that the end user can’t see it – it doesn’t
affect layout or presentation)

Also, jQuery provides the .data(), which makes life easier so you don’t have the trouble of using the [data-*] selector.

If you are providing a class name then, considering semantics, it should have some style associated with it.

John Resig has written about data-attributes

###

Best way to test these things is to search for a test suite on jsperf.com

Here is the one you are interested in:
http://jsperf.com/id-vs-class-vs-data-attribute

The most efficient selector is to use classes.

This is probably a consequence of classes being used more for selection, so browsers will optimize that more?

JsPerf.com results for selection based on ID, Class or attribute

###

If you decide to use the data-* approach, specs for use of custom data elements — and example usage — are given here:

W3 spec on embedding custom non visible data with the data attribute

Here’s a short, relevant excerpt:

3.2.3.8 Embedding custom non-visible data with the data-* attributes
A custom data attribute is an attribute in no namespace whose name starts with the string “data-“, has at least one character after the hyphen, is XML-compatible, and contains no characters in the range U+0041 to U+005A (LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z).

All attributes on HTML elements in HTML documents get ASCII-lowercased automatically, so the restriction on ASCII uppercase letters doesn’t affect such documents.

Custom data attributes are intended to store custom data private to the page or application, for which there are no more appropriate attributes or elements.

Leave a Reply

Your email address will not be published. Required fields are marked *