web api instance method
Element: setAttributeNS() method
[!WARNING] This method can take attribute values that are parsed as HTML, a script, or as a script URL, depending on the attribute. APIs like this are known as injection sinks, and are potentially a vector for cross-site scripting (XSS) attacks, if the value originally came from an attacker.
You can mitigate this risk by always passing the appropriate trusted type object (
TrustedHTML,TrustedScript, orTrustedScriptURL) instead of strings for those attributes that require them, and enforcing trusted types. See Security considerations insetAttribute()for more information.
The setAttributeNS() method of the Element interface adds a new attribute or changes the value of an attribute with the given namespace and name.
If you are working with HTML documents and you don’t need to specify the requested attribute as being part of a specific namespace, use the setAttribute() method instead.
Syntax
setAttributeNS(namespaceURI, qualifiedName, value)
Parameters
-
namespaceURI- : A string specifying the namespace of the attribute to set, or the empty string.
-
qualifiedName- : A string identifying the attribute by its qualified name, which has the format
prefix:localNameorlocalName, where the parts are defined as:-
prefix- : A “short alias” for the namespace.
The prefix is optional, but if it is specified the
namespaceURIparameter must also be specified. If the prefix is set toxmlorxmlns, thenamespaceURImust be set tohttp://www.w3.org/XML/1998/namespaceorhttp://www.w3.org/2000/xmlns/, respectively.
- : A “short alias” for the namespace.
The prefix is optional, but if it is specified the
-
localName- : The local name of the attribute.
-
- : A string identifying the attribute by its qualified name, which has the format
-
value-
: A trusted type or string containing the value to assign to the attribute.
Trusted type instances must be passed for the following attributes when trusted types are enforced:
- Event handler content attributes, such as
onclickandonload, require aTrustedScript. srcdocrequire aTrustedHTMLinstance.srcrequire aTrustedScriptURLinstance.hrefrequire aTrustedScriptURLinstance.
Trusted types are not enforced for other attributes, so a string or any trusted type may be passed.
- Event handler content attributes, such as
-
Return value
None (undefined).
Exceptions
-
NamespaceErrorDOMException- : Thrown if the
namespaceURIvalue is:- not a valid namespace URI.
- set to the empty string when
prefixhas a value. - not the value
http://www.w3.org/XML/1998/namespaceorhttp://www.w3.org/2000/xmlns/whenprefixis set toxmlorxmlns, respectively.
- : Thrown if the
-
InvalidCharacterErrorDOMException-
: Thrown if either the
prefixorlocalNameis not valid:- The
prefixmust have at least one character, and cannot contain ASCII whitespace,NULL,/, or>(U+0000, U+002F, or U+003E, respectively). - The
localNamemust have at least one character, and may not contain ASCII whitespace,NULL,/,=or>(U+0000, U+002F, U+003D, or U+003E, respectively).
[!NOTE] Earlier versions of the specification were more restrictive, requiring that the
qualifiedNamebe a valid XML name. - The
-
-
TypeError- : Thrown if
valueis passed a string instead of a trusted type object (for those attributes that require them) when Trusted Types are enforced by a CSP and no default policy is defined.
- : Thrown if
Examples
Basic usage
let d = document.getElementById("d1");
d.setAttributeNS(
"http://www.mozilla.org/ns/specialspace",
"spec:align",
"center",
);
Trusted types
The Setting unsafe attributes example in setAttribute() shows how you might use setAttributeNS() with the trusted types.