web_extensions / latest / api / tabs / removecss.html /

tabs.removeCSS()

Removes from a page CSS which was previously injected by a call to tabs.insertCSS().

This is an asynchronous function that returns a Promise.

Syntax

let removing = browser.tabs.removeCSS(
  tabId,           // optional integer
  details          // object
)

Parameters

tabId Optional

integer. The ID of the tab from which to remove the CSS. Defaults to the active tab of the current window.

details

An object describing the CSS to remove from the page. It contains the following properties:

allFrames Optional

boolean. If true, the code will be removed from all frames of the current page. If it is false, code is only removed from the top frame. Defaults to false.

code Optional

string. CSS to remove, as a text string. This must exactly match a CSS string previously inserted into the page using tabs.insertCSS().

cssOrigin Optional

string. This can take one of two values: "user", for CSS added as a user stylesheet, or "author" for CSS added as an author stylesheet. If this option was set previously by tabs.insertCSS(), then it must exactly match.

file Optional

string. Path to a file containing the CSS to remove. This must exactly match a CSS file previously inserted into the page using tabs.insertCSS().

frameId Optional

integer. The frame from which to remove the CSS. Defaults to 0 (the top-level frame).

matchAboutBlank Optional

boolean. If true, the CSS will be removed from embedded "about:blank" and "about:srcdoc" frames if your extension has access to their parent document. Defaults to false.

Return value

A Promise that will be fulfilled with no arguments when all the CSS has been removed. If any error occurs, the promise will be rejected with an error message.

Examples

This example adds some CSS using tabs.insertCSS, then removes it again when the user clicks a browser action:

let css = "body { border: 20px dotted pink; }";

function onError(error) {
  console.log(`Error: ${error}`);
}

let insertingCSS = browser.tabs.insertCSS(2, {code: css});
insertingCSS.then(null, onError);

browser.browserAction.onClicked.addListener(() => {
  let removing = browser.tabs.removeCSS(2, {code: css});
  removing.then(null, onError);
});

Example extensions

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
removeCSS
87
87
49
?
73
14
?
?
54
?
15
?

Note: This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/removeCSS