1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
// Copyright 2009 The Closure Library Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* @fileoverview Utilities for adding, removing and setting values in
* an Element's dataset.
* See {@link http://www.w3.org/TR/html5/Overview.html#dom-dataset}.
*
* @author nicksay@google.com (Alex Nicksay)
*/
goog.provide('goog.dom.dataset');
goog.require('goog.labs.userAgent.browser');
goog.require('goog.string');
goog.require('goog.userAgent.product');
/**
* Whether using the dataset property is allowed.
*
* In IE (up to and including IE 11), setting element.dataset in JS does not
* propagate values to CSS, breaking expressions such as
* `content: attr(data-content)` that would otherwise work.
* See {@link https://github.com/google/closure-library/issues/396}.
*
* In Safari >= 9, reading from element.dataset sometimes returns
* undefined, even though the corresponding data- attribute has a value.
* See {@link https://bugs.webkit.org/show_bug.cgi?id=161454}.
* @const
* @private
*/
goog.dom.dataset.ALLOWED_ =
!goog.userAgent.product.IE && !goog.labs.userAgent.browser.isSafari();
/**
* The DOM attribute name prefix that must be present for it to be considered
* for a dataset.
* @type {string}
* @const
* @private
*/
goog.dom.dataset.PREFIX_ = 'data-';
/**
* Returns whether a string is a valid dataset property name.
* @param {string} key Property name for the custom data attribute.
* @return {boolean} Whether the string is a valid dataset property name.
* @private
*/
goog.dom.dataset.isValidProperty_ = function(key) {
return !/-[a-z]/.test(key);
};
/**
* Sets a custom data attribute on an element. The key should be
* in camelCase format (e.g "keyName" for the "data-key-name" attribute).
* @param {Element} element DOM node to set the custom data attribute on.
* @param {string} key Key for the custom data attribute.
* @param {string} value Value for the custom data attribute.
*/
goog.dom.dataset.set = function(element, key, value) {
if (goog.dom.dataset.ALLOWED_ && element.dataset) {
element.dataset[key] = value;
} else if (!goog.dom.dataset.isValidProperty_(key)) {
throw new Error(
goog.DEBUG ? '"' + key + '" is not a valid dataset property name.' :
'');
} else {
element.setAttribute(
goog.dom.dataset.PREFIX_ + goog.string.toSelectorCase(key), value);
}
};
/**
* Gets a custom data attribute from an element. The key should be
* in camelCase format (e.g "keyName" for the "data-key-name" attribute).
* @param {Element} element DOM node to get the custom data attribute from.
* @param {string} key Key for the custom data attribute.
* @return {?string} The attribute value, if it exists.
*/
goog.dom.dataset.get = function(element, key) {
// Edge, unlike other browsers, will do camel-case conversion when retrieving
// "dash-case" properties.
if (!goog.dom.dataset.isValidProperty_(key)) {
return null;
}
if (goog.dom.dataset.ALLOWED_ && element.dataset) {
// Android browser (non-chrome) returns the empty string for
// element.dataset['doesNotExist'].
if (goog.labs.userAgent.browser.isAndroidBrowser() &&
!(key in element.dataset)) {
return null;
}
var value = element.dataset[key];
return value === undefined ? null : value;
} else {
return element.getAttribute(
goog.dom.dataset.PREFIX_ + goog.string.toSelectorCase(key));
}
};
/**
* Removes a custom data attribute from an element. The key should be
* in camelCase format (e.g "keyName" for the "data-key-name" attribute).
* @param {Element} element DOM node to get the custom data attribute from.
* @param {string} key Key for the custom data attribute.
*/
goog.dom.dataset.remove = function(element, key) {
// Edge, unlike other browsers, will do camel-case conversion when removing
// "dash-case" properties.
if (!goog.dom.dataset.isValidProperty_(key)) {
return;
}
if (goog.dom.dataset.ALLOWED_ && element.dataset) {
// In strict mode Safari will trigger an error when trying to delete a
// property which does not exist.
if (goog.dom.dataset.has(element, key)) {
delete element.dataset[key];
}
} else {
element.removeAttribute(
goog.dom.dataset.PREFIX_ + goog.string.toSelectorCase(key));
}
};
/**
* Checks whether custom data attribute exists on an element. The key should be
* in camelCase format (e.g "keyName" for the "data-key-name" attribute).
*
* @param {Element} element DOM node to get the custom data attribute from.
* @param {string} key Key for the custom data attribute.
* @return {boolean} Whether the attribute exists.
*/
goog.dom.dataset.has = function(element, key) {
// Edge, unlike other browsers, will do camel-case conversion when retrieving
// "dash-case" properties.
if (!goog.dom.dataset.isValidProperty_(key)) {
return false;
}
if (goog.dom.dataset.ALLOWED_ && element.dataset) {
return key in element.dataset;
} else if (element.hasAttribute) {
return element.hasAttribute(
goog.dom.dataset.PREFIX_ + goog.string.toSelectorCase(key));
} else {
return !!(
element.getAttribute(
goog.dom.dataset.PREFIX_ + goog.string.toSelectorCase(key)));
}
};
/**
* Gets all custom data attributes as a string map. The attribute names will be
* camel cased (e.g., data-foo-bar -> dataset['fooBar']). This operation is not
* safe for attributes having camel-cased names clashing with already existing
* properties (e.g., data-to-string -> dataset['toString']).
* @param {!Element} element DOM node to get the data attributes from.
* @return {!Object} The string map containing data attributes and their
* respective values.
*/
goog.dom.dataset.getAll = function(element) {
if (goog.dom.dataset.ALLOWED_ && element.dataset) {
return element.dataset;
} else {
var dataset = {};
var attributes = element.attributes;
for (var i = 0; i < attributes.length; ++i) {
var attribute = attributes[i];
if (goog.string.startsWith(attribute.name, goog.dom.dataset.PREFIX_)) {
// We use substr(5), since it's faster than replacing 'data-' with ''.
var key = goog.string.toCamelCase(attribute.name.substr(5));
dataset[key] = attribute.value;
}
}
return dataset;
}
};
|
