jQuery Data vs Attr?

Question

What is the difference in usage between $.data and $.attr when using data-someAttribute?

My understanding is that $.data is stored within jQuery's $.cache, not the DOM. Therefore, if I want to use $.cache for data storage, I should use $.data. If I want to add HTML5 data-attributes, I should use $.attr("data-attribute", "myCoolValue").

Answer 1

If you are passing data to a DOM element from the server, you should set the data on the element:

<a id="foo" data-foo="bar" href="#">foo!</a> 

The data can then be accessed using .data() in jQuery:

console.log( $('#foo').data('foo') ); //outputs "bar" 

However when you store data on a DOM node in jQuery using data, the variables are stored on the node object. This is to accommodate complex objects and references as storing the data on the node element as an attribute will only accommodate string values.

_{Continuing my example from above:}

$('#foo').data('foo', 'baz');  console.log( $('#foo').attr('data-foo') ); //outputs "bar" as the attribute was never changed  console.log( $('#foo').data('foo') ); //outputs "baz" as the value has been updated on the object 

Also, the naming convention for data attributes has a bit of a hidden "gotcha":

_HTML:

<a id="bar" data-foo-bar-baz="fizz-buzz" href="#">fizz buzz!</a> 

_JS:

console.log( $('#bar').data('fooBarBaz') ); //outputs "fizz-buzz" as hyphens are automatically camelCase'd 

The hyphenated key will still work:

_HTML:

<a id="bar" data-foo-bar-baz="fizz-buzz" href="#">fizz buzz!</a> 

_JS:

console.log( $('#bar').data('foo-bar-baz') ); //still outputs "fizz-buzz" 

However the object returned by .data() will not have the hyphenated key set:

$('#bar').data().fooBarBaz; //works $('#bar').data()['fooBarBaz']; //works $('#bar').data()['foo-bar-baz']; //does not work 

It's for this reason I suggest avoiding the hyphenated key in javascript.

For HTML, keep using the hyphenated form. HTML attributes are supposed to get ASCII-lowercased automatically, so <div data-foobar></div>, <DIV DATA-FOOBAR></DIV>, and <dIv DaTa-FoObAr></DiV> are supposed to be treated as identical, but for the best compatibility the lower case form should be preferred.

The .data() method will also perform some basic auto-casting if the value matches a recognized pattern:

_HTML:

<a id="foo"     href="#"     data-str="bar"     data-bool="true"     data-num="15"     data-json='{"fizz":["buzz"]}'>foo!</a> 

_JS:

$('#foo').data('str');  //`"bar"` $('#foo').data('bool'); //`true` $('#foo').data('num');  //`15` $('#foo').data('json'); //`{fizz:['buzz']}` 

This auto-casting ability is very convenient for instantiating widgets & plugins:

$('.widget').each(function () {     $(this).widget($(this).data());     //-or-     $(this).widget($(this).data('widget')); }); 

If you absolutely must have the original value as a string, then you'll need to use .attr():

_HTML:

<a id="foo" href="#" data-color="ABC123"></a> <a id="bar" href="#" data-color="654321"></a> 

_JS:

$('#foo').data('color').length; //6 $('#bar').data('color').length; //undefined, length isn't a property of numbers  $('#foo').attr('data-color').length; //6 $('#bar').attr('data-color').length; //6 

_{This was a contrived example. For storing color values, I used to use numeric hex notation (i.e. 0xABC123), but it's worth noting that hex was parsed incorrectly in jQuery versions before 1.7.2, and is no longer parsed into a Number as of jQuery 1.8 rc 1.}

jQuery 1.8 rc 1 changed the behavior of auto-casting. Before, any format that was a valid representation of a Number would be cast to Number. Now, values that are numeric are only auto-cast if their representation stays the same. This is best illustrated with an example.

_HTML:

<a id="foo"     href="#"     data-int="1000"     data-decimal="1000.00"     data-scientific="1e3"     data-hex="0x03e8">foo!</a> 

_JS:

                              // pre 1.8    post 1.8 $('#foo').data('int');        //    1000        1000 $('#foo').data('decimal');    //    1000   "1000.00" $('#foo').data('scientific'); //    1000       "1e3" $('#foo').data('hex');        //    1000     "0x03e8" 

If you plan on using alternative numeric syntaxes to access numeric values, be sure to cast the value to a Number first, such as with a unary + operator.

_{JS (cont.):}

+$('#foo').data('hex'); // 1000