tabs.executeScript()

Syntax

let executing = browser.tabs.executeScript(
  tabId,                 // optional integer
  details                // object
)

Parameter

tabId Optional

integer. Die ID des Tabs, in dem das Skript ausgeführt werden soll.

Standardmäßig der aktive Tab des aktuellen Fensters.

details

Ein Objekt, das das auszuführende Skript beschreibt.

Es enthält die folgenden Eigenschaften:

allFrames Optional

boolean. Wenn true, wird der Code in alle Frames der aktuellen Seite injiziert.

Wenn auf true gesetzt und frameId ist ebenfalls gesetzt, wird ein Fehler ausgelöst. (frameId und allFrames schließen sich gegenseitig aus.)

Wenn es false ist, wird der Code nur in den obersten Frame injiziert.

Standardwert ist false.

code Optional

string. Code, der als Textzeichenfolge injiziert werden soll.

Warnung: Verwenden Sie diese Eigenschaft nicht, um nicht vertrauenswürdige Daten in JavaScript einzusetzen, da dies zu einem Sicherheitsproblem führen könnte.

file Optional

string. Pfad zu einer Datei, die den zu injizierenden Code enthält.

• In Firefox werden relative URLs, die nicht am Erweiterungsstamm beginnen, relativ zur aktuellen Seiten-URL aufgelöst.
• In Chrome werden diese URLs relativ zur Basis-URL der Erweiterung aufgelöst.

Um browserübergreifend zu arbeiten, können Sie den Pfad als relative URL angeben, beginnend am Stamm der Erweiterung, wie folgt: "/path/to/script.js".

frameId Optional

integer. Der Frame, in den der Code injiziert werden soll.

Standardwert ist 0 (das oberste Frame).

matchAboutBlank Optional

boolean. Wenn true, wird der Code in eingebettete about:blank und about:srcdoc Frames injiziert, wenn Ihre Erweiterung Zugang zu ihrem übergeordneten Dokument hat. Der Code kann nicht in oberste about: Frames eingefügt werden.

Standardwert ist false.

runAt Optional

extensionTypes.RunAt. Der früheste Zeitpunkt, zu dem der Code in den Tab injiziert wird.

Standardwert ist "document_idle".

Rückgabewert

Ein Promise, das in einem Array von Objekten aufgelöst wird. Die Werte des Arrays repräsentieren das Ergebnis des Skriptes in jedem injizierten Frame.

Das Ergebnis des Skriptes ist die zuletzt ausgewertete Anweisung, die dem Ausgabeverhalten (den Ergebnissen, nicht der Ausgabe von console.log()) ähnelt, wenn Sie das Skript in der Web-Konsole ausgeführt haben. Zum Beispiel könnte ein Skript so aussehen:

let foo = "my result";
foo;

Hier enthält das Ergebnisarray den String "my result" als Element.

Die Ergebniswerte müssen strukturiert klonbar sein (siehe Datenklon-Algorithmus).

Wenn ein Fehler auftritt, wird das Promise mit einer Fehlermeldung abgelehnt.

Beispiele

Dieses Beispiel führt ein einzeiliges Code-Snippet im aktiven Tab aus:

function onExecuted(result) {
  console.log(`We made it green`);
}

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

const makeItGreen = 'document.body.style.border = "5px solid green"';

const executing = browser.tabs.executeScript({
  code: makeItGreen,
});
executing.then(onExecuted, onError);

Dieses Beispiel führt ein Skript aus einer Datei (mit der Erweiterung gepackt) mit dem Namen "content-script.js" aus. Das Skript wird im aktiven Tab ausgeführt. Das Skript wird sowohl in Subframes als auch im Hauptdokument ausgeführt:

function onExecuted(result) {
  console.log(`We executed in all subframes`);
}

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

const executing = browser.tabs.executeScript({
  file: "/content-script.js",
  allFrames: true,
});
executing.then(onExecuted, onError);

Dieses Beispiel führt ein Skript aus einer Datei (mit der Erweiterung gepackt) mit dem Namen "content-script.js" aus. Das Skript wird im Tab mit der ID 2 ausgeführt:

function onExecuted(result) {
  console.log(`We executed in tab 2`);
}

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

const executing = browser.tabs.executeScript(2, {
  file: "/content-script.js",
});
executing.then(onExecuted, onError);

Beispielerweiterungen

• beastify
• context-menu-copy-link-with-types
• devtools-panels
• imagify
• menu-demo
• menu-remove-element

Browser-Kompatibilität