Element: toggleAttribute() method
DOM
DOM
The toggleAttribute() method of the Element interface toggles a Boolean attribute on the given element, removing it if present and adding it if not present.
Syntax
toggleAttribute(name)
toggleAttribute(name, force)
Parameters
name- : A string 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- : A boolean value which has the following effects:
- if not specified at all, the
toggleAttributemethod "toggles" the attribute namedname— removing it if it is present, or else adding it if it is not present - if true, the
toggleAttributemethod adds an attribute namedname - if false, the
toggleAttributemethod removes the attribute namedname
- if not specified at all, the
Return value
true if attribute name is eventually
present, and false otherwise.
Exceptions
InvalidCharacterErrorDOMException- : The specified attribute
namecontains one or more characters that are not valid in attribute names. Thenamemust have at least one character, and may not contain ASCII whitespace,NULL,/,=or>(U+0000, U+002F, U+003D, or U+003E, respectively).
Examples
Basic usage
In the following example, toggleAttribute() is used to toggle the disabled attribute of an input.
HTML
<input value="text" /> <button>toggleAttribute("disabled")</button>
JavaScript
const button = document.querySelector("button");
const input = document.querySelector("input");
button.addEventListener("click", () => {
input.toggleAttribute("disabled");
});
Result
300
Specifications
Browser compatibility
See also
- Element.hasAttribute()
- Element.getAttribute()
- Element.removeAttribute()
- Element.setAttribute()