The toggle()
method of the DOMTokenList
interface removes a given token from the list and returns false
. If token doesn't exist it's added and the function returns true
.
Syntax
tokenList.toggle(token, force);
Parameters
- token
- A
DOMString
representing the token you want to toggle. - force Optional
- A
Boolean
that, if included, turns the toggle into a one way-only operation. If set tofalse
, the token will only be removed but not added again. If set totrue
, the token will only be added but not removed again.
Return value
A Boolean
— false
if the token is not in the list after the call, or true
if the token is in the list after the call.
Examples
In the following example we retrieve the list of classes set on a <span>
element as a DOMTokenList
using Element.classList
. We then replace a token in the list, and write the list into the <span>
's Node.textContent
.
First, the HTML:
<span class="a b">classList is 'a b'</span>
Now the JavaScript:
var span = document.querySelector("span"); var classes = span.classList; span.onclick = function() { var result = classes.toggle("c"); if(result) { span.textContent = "'c' added; classList is now '" + classes + "'."; } else { span.textContent = "'c' removed; classList is now '" + classes + "'."; } }
The output looks like this:
Specifications
Specification | Status | Comment |
---|---|---|
DOM The definition of 'toggle()' in that specification. |
Living Standard | Initial definition |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | (Yes) | (Yes) | No support | (Yes) | (Yes) |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|
Basic support | ? | (Yes) | (Yes) | No support | (Yes) | (Yes) | (Yes) |
Document Tags and Contributors
Tags:
Contributors to this page:
Endyl,
chrisdavidmills
Last updated by:
Endyl,