-
Notifications
You must be signed in to change notification settings - Fork 38
Expand file tree
/
Copy pathDOMTokenList.html
More file actions
95 lines (95 loc) · 16.1 KB
/
Copy pathDOMTokenList.html
File metadata and controls
95 lines (95 loc) · 16.1 KB
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
<!DOCTYPE html><html><head><meta charset="utf-8"><title>DOMTokenList JavaScript API</title><meta name="description" content="Interactive API reference for the JavaScript DOMTokenList Object. An object containing a list of strings. Used in Element.classList and HTMLIFrameElement.sandbox."><link rel="stylesheet" type="text/css" href="styles.css"><script type="text/javascript">var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23450559-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();</script></head><body><script>if (sessionStorage.collapsed === 'true') {
document.body.classList.add('members-collapsed');
}
if (localStorage.theme) {
document.body.parentElement.classList.add(localStorage.theme);
}</script><div class="topnav"><a href="/">JavaScripture</a><div class="bookmarks"><a class="bookmark contribute" href="https://github.com/nkronlage/JavaScripture">Contribute via GitHub</a> <a class="bookmark" href="/feedback">Feedback</a></div></div><div class="container"><nav class="leftnav"><div id="searchContainer"><input id="searchBox" type="text" placeholder="Search (Ctrl + S)" autocomplete="false"><div id="resultsBox" style="display:none;"></div></div><div id="apichooser"><a href="#" onclick="openApiChooser(); return false;"><div class="arrow"></div><span id="selectedsets"></span></a><div id="obscure"></div><div id="apisets"><ul></ul></div></div><div class="toc"><h2>DOMTokenList</h2><div class="navgroup"><div class="group"><a href="#InstanceIndexers">Instance Indexers</a></div><div class="group collapsed"><a href="#InstanceProperties" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Properties</a><div class="subgroup"><a href="#length">length</a><a href="#value">value</a></div></div><div class="group collapsed"><a href="#InstanceMethods" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Methods</a><div class="subgroup"><a href="#add_String">add</a><a href="#contains_String">contains</a><a href="#item_Number">item</a><a href="#remove_String">remove</a><a href="#replace_String_String">replace</a><a href="#toggle_String_Boolean">toggle</a></div></div></div><h2>DOM API</h2><div id="related-apis" class="navgroup"></div><h2>All API</h2><div id="rootObjs" class="navgroup"><span class="empty">No API set selected.</span></div></div></nav><div class="content"><h1 class="declaration"><span class="object">DOMTokenList</span> <span class="type">: <a href="/Object">Object</a></span></h1><div class="metadata"></div><div class="objectdescription">An object containing a list of strings. Used in <a href="/Element#classList"><code>Element.classList</code></a> and <a href="/HTMLIFrameElement#sandbox"><code>HTMLIFrameElement.sandbox</code></a>.<div class="membermetadata"><a href="https://dom.spec.whatwg.org/#domtokenlist" class="spec">Spec</a></div></div><div><a name="InstanceIndexers"></a><h2>Instance Indexers</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="indexer_Number"></a><div class="declaration"><span class="membername primary">this</span>[<span class="membername">index</span> : <a class="membertype" href="/Number">Number</a>] : <a class="membertype" href="/String">String</a></div><div class="member-body"><p class="description">Retrieves the token at <code>index</code>. You can also use the <a href="#item"><code>item()</code></a> method.</p><div class="htmlexample"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="19" cols="60" wrap="off">
<span id='foo' class='bar baz'>foo</span>
<script>
var foo = document.getElementById('foo');
for (var i = 0; i < foo.classList.length; i++) {
console.log(foo.classList[i]);
}
</script>
</textarea><a onclick='executeHTMLExample(this.parentNode.parentNode, "DOMTokenList.undefined"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="htmlerrormessage" style="display: none"></div><iframe class="output" width="350" height="200"></iframe><pre class="results"> </pre></div></div></div><p></p></div></div></div><div><a name="InstanceProperties"></a><h2>Instance Properties</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="length"></a><div class="declaration"><span class="membername primary">length</span> : <a class="membertype" href="/Number">Number</a> <span class="metadata">readonly</span></div><div class="member-body"><p class="description">The number of tokens in <code>this</code>.</p><div class="htmlexample"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="19" cols="60" wrap="off">
<span id='foo' class='bar baz'>foo</span>
<script>
var foo = document.getElementById('foo');
console.log(foo.classList.length);
</script>
</textarea><a onclick='executeHTMLExample(this.parentNode.parentNode, "DOMTokenList.length"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="htmlerrormessage" style="display: none"></div><iframe class="output" width="350" height="200"></iframe><pre class="results"> </pre></div></div></div><p></p><div class="membermetadata"><a href="https://dom.spec.whatwg.org/#dom-domtokenlist-length" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="value"></a><div class="declaration"><span class="membername primary">value</span> : <a class="membertype" href="/String">String</a></div><div class="member-body"><p class="description">A string value of the token list. See also <a href="/Element#className">className</a>.</p><div class="htmlexample"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="19" cols="60" wrap="off">
<style>
.bar { font-weight: bold; }
.baz { color: red; }
</style>
<span id='foo'>foo</span>
<script>
var foo = document.getElementById('foo');
foo.classList.value = 'bar baz';
</script>
</textarea><a onclick='executeHTMLExample(this.parentNode.parentNode, "DOMTokenList.value"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="htmlerrormessage" style="display: none"></div><iframe class="output" width="350" height="200"></iframe><pre class="results"> </pre></div></div></div><p></p><div class="membermetadata"><a href="https://dom.spec.whatwg.org/#dom-domtokenlist-value" class="spec">Spec</a></div></div></div></div><div><a name="InstanceMethods"></a><h2>Instance Methods</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="add"></a> <a name="add_String"></a><div class="declaration"><span class="membername primary">add</span>(<span class="membername">token</span> : <a class="membertype" href="/String">String</a>) : <a class="membertype" href="/undefined">undefined</a></div><div class="member-body"><p class="description">Adds <code>token</code> to <code>this</code>.</p><div class="htmlexample"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="19" cols="60" wrap="off">
<style>
.bar { font-weight: bold; }
.baz { color: red; }
</style>
<span id='foo' class='bar'>foo</span>
<button onclick='addClass()'>Add Class</button>
<script>
var addClass = function() {
var foo = document.getElementById('foo');
foo.classList.add('baz');
};
</script>
</textarea><a onclick='executeHTMLExample(this.parentNode.parentNode, "DOMTokenList.add"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="htmlerrormessage" style="display: none"></div><iframe class="output" width="350" height="200"></iframe><pre class="results"> </pre></div></div></div><p></p><div class="membermetadata"><a href="https://dom.spec.whatwg.org/#dom-domtokenlist-add" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="contains"></a> <a name="contains_String"></a><div class="declaration"><span class="membername primary">contains</span>(<span class="membername">token</span> : <a class="membertype" href="/String">String</a>) : <a class="membertype" href="/Boolean">Boolean</a></div><div class="member-body"><p class="description">Returns <code>true</code> if <code>token</code> is in <code>this</code> and <code>false</code> otherwise.</p><div class="htmlexample"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="19" cols="60" wrap="off">
<span id='foo' class='bar'>foo</span>
<script>
var foo = document.getElementById('foo');
console.log(foo.classList.contains('bar'));
console.log(foo.classList.contains('baz'));
</script>
</textarea><a onclick='executeHTMLExample(this.parentNode.parentNode, "DOMTokenList.contains"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="htmlerrormessage" style="display: none"></div><iframe class="output" width="350" height="200"></iframe><pre class="results"> </pre></div></div></div><p></p><div class="membermetadata"><a href="https://dom.spec.whatwg.org/#dom-domtokenlist-contains" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="item"></a> <a name="item_Number"></a><div class="declaration"><span class="membername primary">item</span>(<span class="membername">index</span> : <a class="membertype" href="/Number">Number</a>) : <a class="membertype" href="/String">String</a></div><div class="member-body"><p class="description">Same as <a href="#indexer_Number"><code>this[index]</code></a>.</p><div class="membermetadata"><a href="https://dom.spec.whatwg.org/#dom-domtokenlist-item" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="remove"></a> <a name="remove_String"></a><div class="declaration"><span class="membername primary">remove</span>(<span class="membername">token</span> : <a class="membertype" href="/String">String</a>) : <a class="membertype" href="/undefined">undefined</a></div><div class="member-body"><p class="description">Removes <code>token</code> from <code>this</code>.</p><div class="htmlexample"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="19" cols="60" wrap="off">
<style>
.bar { font-weight: bold; }
.baz { color: red; }
</style>
<span id='foo' class='bar baz'>foo</span>
<button onclick='removeClass()'>Remove Class</button>
<script>
var removeClass = function() {
var foo = document.getElementById('foo');
foo.classList.remove('baz');
};
</script>
</textarea><a onclick='executeHTMLExample(this.parentNode.parentNode, "DOMTokenList.remove"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="htmlerrormessage" style="display: none"></div><iframe class="output" width="350" height="200"></iframe><pre class="results"> </pre></div></div></div><p></p><div class="membermetadata"><a href="https://dom.spec.whatwg.org/#dom-domtokenlist-remove" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="replace"></a> <a name="replace_String_String"></a><div class="declaration"><span class="membername primary">replace</span>(<span class="membername">oldToken</span> : <a class="membertype" href="/String">String</a>, <span class="membername">newToken</span> : <a class="membertype" href="/String">String</a>) : <a class="membertype" href="/Boolean">Boolean</a></div><div class="member-body"><p class="description">If <code>oldToken</code> is present in <code>this</code>, removes <code>oldToken</code>, adds <code>newToken</code>, and returns <code>true</code>. Otherwise, makes no changes and returns <code>false</code>.</p><div class="htmlexample"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="19" cols="60" wrap="off">
<style>
.bar { font-weight: bold; }
.baz { color: red; }
.not-applied { font-size: 2em; }
</style>
<span id='foo' class='bar'>foo</span>
<script>
var foo = document.getElementById('foo');
console.log(foo.classList.replace('bar', 'baz'));
console.log(foo.classList.replace('bar', 'not-applied'));
</script>
</textarea><a onclick='executeHTMLExample(this.parentNode.parentNode, "DOMTokenList.replace"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="htmlerrormessage" style="display: none"></div><iframe class="output" width="350" height="200"></iframe><pre class="results"> </pre></div></div></div><p></p><div class="membermetadata"><a href="https://dom.spec.whatwg.org/#dom-domtokenlist-replace" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="toggle"></a> <a name="toggle_String_Boolean"></a><div class="declaration"><span class="membername primary">toggle</span>(<span class="membername">token</span> : <a class="membertype" href="/String">String</a>, <span class="optional">[<span class="membername">value</span> : <a class="membertype" href="/Boolean">Boolean</a>]</span>) : <a class="membertype" href="/Boolean">Boolean</a></div><div class="member-body"><p class="description">If <code>value</code> is not specified, removes <code>token</code> from the list if was in <code>this</code> or adds <code>token</code> to the list if it was not in <code>this</code>. If <code>value</code> is <code>true</code>, <code>token</code> is added to <code>this</code> if not already there. If <code>value</code> is <code>false</code>, <code>token</code> is removed from <code>this</code>.</p><div class="htmlexample"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="19" cols="60" wrap="off">
<style>
.bar { font-weight: bold; }
.baz { color: red; }
</style>
<span id='foo' class='bar baz'>foo</span>
<button onclick='toggleClass()'>Toggle Class</button>
<script>
var toggleClass = function() {
var foo = document.getElementById('foo');
foo.classList.toggle('baz');
};
</script>
</textarea><a onclick='executeHTMLExample(this.parentNode.parentNode, "DOMTokenList.toggle"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="htmlerrormessage" style="display: none"></div><iframe class="output" width="350" height="200"></iframe><pre class="results"> </pre></div></div></div><p></p><div class="membermetadata"><a href="https://dom.spec.whatwg.org/#dom-domtokenlist-toggle" class="spec">Spec</a></div></div></div></div><div class="bottomnav"><a href="/">home</a> <a href="/license">license</a> <a href="https://github.com/nkronlage/JavaScripture">contribute</a> <a href="/feedback">feedback</a> <a id="toggle-theme" href="#">toggle light/dark mode</a></div><div class="copyright">Copyright © JavaScripture Contributors</div></div></div></body><script src="javascripture.js"></script></html>