Add-ons

tabs.insertCSS()

Injects CSS into a page.

To use this API you must have the permission for the page's URL, either explicitly as a host permission, or using the activeTab permission.

You can only inject CSS into pages whose URL can be expressed using a match pattern: meaning, its scheme must be one of "http", "https", "file", "ftp". This means that you can't inject CSS into any of the browser's built-in pages, such as about:debugging, about:addons, or the page that opens when you open a new empty tab.

The inserted CSS may be removed again by calling tabs.removeCSS().

This is an asynchronous function that returns a Promise.

Syntax

var inserting = browser.tabs.insertCSS(
  tabId,           // optional integer
  details          // object
)

Parameters

tabId Optional
integer. The ID of the tab in which to insert the CSS. Defaults to the active tab of the current window.
details
An object describing the CSS to insert. It contains the following properties:
allFramesOptional
boolean. If true, the CSS will be injected into all frames of the current page. If it is false, CSS is only injected into the top frame. Defaults to false.
codeOptional
string. Code to inject, as a text string.
cssOriginOptional
string. This can take one of two values: "user", to add the CSS as a user stylesheet, or "author" to add it as an author stylesheet. Specifying "user" enables you to prevent websites from overriding the CSS you insert: see Cascading order. If this option is omitted, the CSS is added as an author stylesheet.
fileOptional
string. Path to a file containing the code to inject. In Firefox, relative URLs are resolved relative to the current page URL. In Chrome, these URLs are resolved relative to the extension's base URL. To work cross-browser, you can specify the path as an absolute URL, starting at the extension's root, like this: "/path/to/stylesheet.css".
frameIdOptional
integer. The frame where the CSS should be injected. Defaults to 0 (the top-level frame).
matchAboutBlankOptional
boolean. If true, the code will be injected into embedded "about:blank" and "about:srcdoc" frames if your extension has access to their parent document. The code cannot be inserted in top-level about: frames. Defaults to false.
runAtOptional
extensionTypes.RunAt. The soonest that the code will be injected into the tab. Defaults to "document_idle".

Return value

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

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportYesYes4754Yes
runAt20No475415
frameId39Yes475426
matchAboutBlank39YesNoNo26
cssOriginNoNo5354No

Examples

This example inserts into the currently active tab CSS which is taken from a string.

var css = "body { border: 20px dotted pink; }";
browser.browserAction.onClicked.addListener(() => {
  function onError(error) {
    console.log(`Error: ${error}`);
  }
  var insertingCSS = browser.tabs.insertCSS({code: css});
  insertingCSS.then(null, onError);
});

This example inserts CSS which is loaded from a file packaged with the extension. The CSS is inserted into the tab whose ID is 2:

browser.browserAction.onClicked.addListener(() => {
  function onError(error) {
    console.log(`Error: ${error}`);
  }
  var insertingCSS = browser.tabs.insertCSS(2, {file: "content-style.css"});
  insertingCSS.then(null, onError);
});

Example extensions

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

Tags: 
 Contributors to this page: andrewtruongmoz, snoack, wbamberg, Makyen, matthewjwein, Sheppy, kmaglione
 Last updated by: andrewtruongmoz,