CSSStyleSheet.addRule()

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The obsolete CSSStyleSheet interface's addRule() legacy method adds a new rule to the stylesheet. You should avoid using this method, and should instead use the more standard insertRule() method.

Syntax

var result = cssStyleSheet.addRule(selector, styleBlock, index);

Parameters

selector
A DOMString specifying the selector portion of the CSS rule. The default is the string undefined.
styleBlock
A DOMString indicating the style block to apply to elements matching the selector. The default is the string undefined.
index Optional
An optional index into the stylesheet's CSSRuleList at which to insert the new rule. If index is not specified, the next index after the last item currently in the list is used (that is, the value of cssStyleSheet.cssRules.length).

Return value

Always returns -1.

Note that due to somewhat estoteric rules about where you can legally insert rules, it's possible that an exception may be thrown. See insertRule() for more information.

Usage notes

This method is implemented by browsers by constructing a string using the template literal `${selector}{${styleBlock}}`, then passing it into the standard insertRule() method.

Therefore, given existing code such as the following:

cssStyleSheet.addRule(selector, styles, 0);

You can rewrite this to use the more standard insertRule() like this:

cssStyleSheet.insertRule(`${selector} {${styles}}`, 0);

Specifications

Specification
CSS Object Model (CSSOM) (CSSOM)
# dom-cssstylesheet-addrule

Browser compatibility

BCD tables only load in the browser

See also