Element.toggleAttribute()

Toggle a boolean attribute (removing it if it is present and adding it if it is not present) on the specified element.

Syntax

Element.toggleAttribute(name[, force]);

Parameters

name
A DOMString specifying the name of the attribute to be toggled. The attribute name is automatically converted to all lower-case when toggleAttribute() is called on an HTML element in an HTML document.
force Optional
A boolean value to determine whether the attribute should be added or removed, no matter whether the attribute is present or not at the moment.

Return value

true if attribute name is eventually present, and false otherwise.

Exceptions

InvalidCharacterError
The specified attribute name contains one or more characters which are not valid in attribute names.

Example

In the following example, toggleAttribute() is used to toggle the readonly attribute of a <input>.

HTML

<input value="text">
<button>toggleAttribute("readonly")</button>

JavaScript

var button = document.querySelector("button"); 
var input = document.querySelector("input"); 

button.addEventListener("click", function(){
  input.toggleAttribute("readonly");
});

DOM methods dealing with element's attributes:

Not namespace-aware, most commonly used methods Namespace-aware variants (DOM Level 2) DOM Level 1 methods for dealing with Attr nodes directly (seldom used) DOM Level 2 namespace-aware methods for dealing with Attr nodes directly (seldom used)
setAttribute (DOM 1) setAttributeNS setAttributeNode setAttributeNodeNS
getAttribute (DOM 1) getAttributeNS getAttributeNode getAttributeNodeNS
hasAttribute (DOM 2) hasAttributeNS - -
removeAttribute (DOM 1) removeAttributeNS removeAttributeNode -

Polyfill

if (!Element.prototype.toggleAttribute) {
  Element.prototype.toggleAttribute = function(name, force) {
    var forcePassed = arguments.length === 2;
    var forceOn = !!force;
    var forceOff = forcePassed && !force;
    
    if (this.getAttribute(name) !== null) {
      if (forceOn) return true;
      
      this.removeAttribute(name);
      return false;
    } else {
      if (forceOff) return false;
      
      this.setAttribute(name, "");
      return true;
    }
  };
}   

Specification

Specification Status Comment
DOM
The definition of 'Element.toggleAttribute' in that specification.
Living Standard  

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support69 ?63 ?56 ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support6969 ?6356 ? ?

Document Tags and Contributors

Contributors to this page: chrisdavidmills, estelle, ziyunfei
Last updated by: chrisdavidmills,