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

var removing = browser.tabs.removeCSS(
  tabId,           // optional integer
  details          // extensionTypes.InjectDetails
)

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
extensionTypes.InjectDetails. An object describing the CSS to remove from the page. It contains the following properties:
 
allFramesOptional
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.
codeOptional
string. CSS to remove, as a text string. This must exactly match a CSS string previously inserted into the page using tabs.insertCSS().
fileOptional
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().
frameIdOptional
integer. The frame from which to remove the CSS. Defaults to 0 (the top-level frame).
matchAboutBlankOptional
boolean. If true, the CSS will be removed from embedded "about:blank" and "about:srcdoc" frames if your add-on 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.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support No No 49.0 No No

Compatibility notes

Firefox

  • 'matchAboutBlank' is not supported.

Examples

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

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

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

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

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

Acknowledgements

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.

Document Tags and Contributors

 Contributors to this page: wbamberg, Sheppy
 Last updated by: wbamberg,