tabs.executeScript()

Injects JavaScript code into a page. For details, see the programmatic injection section of the content scripts doc.

Syntax

browser.tabs.executeScript(
  tabId,                 // optional integer
  details,               // extensionTypes.InjectDetails
  function(result) {...} // optional function
)

Parameters

tabIdOptional

integer. The ID of the tab in which to run the script; defaults to the active tab of the current window.

details

extensionTypes.InjectDetails. Details of the script to run.

Values of this type are objects. They contain the following properties:

codeOptional

string. JavaScript or CSS code to inject.

Warning:
Be careful using the code parameter. Incorrect use of it may open your extension to cross-site scripting attacks.

fileOptional

string. JavaScript or CSS file to inject.

allFramesOptional

boolean. If allFrames is true, implies that the JavaScript or CSS should be injected into all frames of the current page. By default, it's false and is only injected into the top frame.

matchAboutBlankOptional

boolean. If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has access to its parent document. The code cannot be inserted in top-level about:-frames. By default it is false.

runAtOptional

extensionTypes.RunAt. The soonest that the JavaScript or CSS will be injected into the tab. Defaults to "document_idle".

callbackOptional Requires Gecko 47

function. Called after all the JavaScript has been executed.The function is passed the following arguments:

resultOptional

array of any. The result of the script in every injected frame.

Browser compatibility

Examples

Example add-ons

• beastify

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.