.data()
Store arbitrary data associated with the matched elements. Return arbitrary data associated with the first element in the jQuery collection, as set by data() or by an HTML5 data-* attribute.
.data(key, value)🡢 jQuery
key
| String | A string naming the piece of data to set. |
value
| Anything | The new data value; this can be any Javascript type except undefined . |
.data(obj)🡢 jQuery
obj
| Object | An object of key-value pairs of data to update. |
The .data()
method allows us to attach data of any type to DOM elements in a way that is safe from circular references and therefore from memory leaks.
We can set several distinct values for a single element and retrieve them later:
$("body").data("foo", 52);
$("body").data("bar", { isManual: true });
$("body").data({ baz: [1, 2, 3] });
$("body").data("foo"); // 52
$("body").data(); // { foo: 52, bar: { isManual: true }, baz: [ 1, 2, 3 ] }
Using the data()
method to update data does not affect attributes in the DOM. To set a data-*
attribute value, use attr
.
Prior to jQuery 1.4.3, .data( obj )
completely replaced all data. Since jQuery 1.4.3, data is instead extended by shallow merge.
Since jQuery 3, every two-character sequence of "-" (U+002D) followed by a lowercase ASCII letter in a key is replaced by the uppercase version of the letter, in alignment with the HTML dataset API. A statement like $( "body" ).data( { "my-name": "aValue" } ).data();
will return { myName: "aValue" }
.
Due to the way browsers interact with plugins and external code, the .data()
method cannot be used on <object>
(unless it's a Flash plugin), <applet>
or <embed>
elements.
Store then retrieve a value from the div element.
<div>
The values stored were
<span></span>
and
<span></span>
</div>
div {
color: blue;
}
span {
color: red;
}
$("div").data("test", { first: 16, last: "pizza!" });
$("span").first().text($("div").data("test").first);
$("span").last().text($("div").data("test").last);
.data(key)🡢 Object
key
| String | Name of the data stored. |
.data()🡢 Object
The .data()
method allows us to read data previously associated with DOM elements. We can retrieve several distinct values for a single element one at a time, or as a set:
var elem = document.createElement("span");
$(elem).data("foo"); // undefined
$(elem).data(); // {}
$(elem).data("foo", 42);
$(elem).data("foo"); // 42
$(elem).data(); // { foo: 42 }
Calling .data()
with no parameters returns a JavaScript object containing each stored value as a property. The object can be used directly to get data values (but note that property names originally containing dashes will have been modified as described below).
Since jQuery 3, every two-character sequence of "-" (U+002D) followed by a lowercase ASCII letter in a key is replaced by the uppercase version of the letter, in alignment with the HTML dataset API. A statement like $( "body" ).data( { "my-name": "aValue" } ).data();
will return { myName: "aValue" }
.
HTML5 data-*
Attributes
Since jQuery 1.4.3, data-*
attributes are used to initialize jQuery data. An element's data-*
attributes are retrieved the first time the data()
method is invoked upon it, and then are no longer accessed or mutated (all values are stored internally by jQuery).
Every attempt is made to convert the attribute's string value to a JavaScript value (this includes booleans, numbers, objects, arrays, and null). A string is only converted to a number if doing so doesn't change its representation (for example, the string "100" is converted to the number 100, but "1E02" and "100.000" are left as strings because their numeric value of 100 serializes to "100"). When a string starts with '{' or '[', then jQuery.parseJSON
is used to parse it; it must follow valid JSON syntax including quoted property names. A string not parseable as a JavaScript value is not converted.
To retrieve a data-*
attribute value as an unconverted string, use the attr()
method.
Since jQuery 1.6, dashes in data-*
attribute names have been processed in alignment with the HTML dataset API.
For example, given the following HTML:
<div
data-role="page"
data-last-value="43"
data-hidden="true"
data-options='{"name":"John"}'
></div>
The following comparisons are all true:
$("div").data("role") === "page";
$("div").data("lastValue") === 43;
$("div").data("hidden") === true;
$("div").data("options").name === "John";
Get the data named "blah" stored at for an element.
<div>A div</div>
<button>Get "blah" from the div</button>
<button>Set "blah" to "hello"</button>
<button>Set "blah" to 86</button>
<button>Remove "blah" from the div</button>
<p>The "blah" value of this div is <span>?</span></p>
div {
margin: 5px;
background: yellow;
}
button {
margin: 5px;
font-size: 14px;
}
p {
margin: 5px;
color: blue;
}
span {
color: red;
}
$("button").click(function () {
var value;
switch ($("button").index(this)) {
case 0:
value = $("div").data("blah");
break;
case 1:
$("div").data("blah", "hello");
value = "Stored!";
break;
case 2:
$("div").data("blah", 86);
value = "Stored!";
break;
case 3:
$("div").removeData("blah");
value = "Removed!";
break;
}
$("span").text("" + value);
});