contentScripts.register()

Syntax

let registering = browser.contentScripts.register(
  contentScriptOptions       // object
)

Parameter

contentScriptOptions

object. Ein RegisteredContentScriptOptions Objekt, das die zu registrierenden Inhaltsskripte darstellt. Es hat eine ähnliche Syntax wie die Objekte im Array des content_scripts Manifests. Die Unterschiede sind:

• Eigenschaftsnamen verwenden camel case anstelle von Unterstrichen (snake case) — zum Beispiel excludeMatches statt exclude_matches.
• Die Eigenschaften js und css erlauben es, Strings ebenso wie URLs zu registrieren, daher muss ihre Syntax diese Typen unterscheiden.

Das RegisteredContentScriptOptions Objekt hat folgende Eigenschaften:

allFrames Optional

Entspricht all_frames im content_scripts Schlüssel.

cookieStoreId Optional

Ein String oder Array von Strings. Registriert das Inhaltsskript in den Tabs, die zu einer oder mehreren Cookie-Store-IDs gehören. Dies ermöglicht es, Skripte für alle Standard- oder nicht-kontextbezogenen Identitäts-Tabs, Tabs im privaten Modus (wenn die Erweiterung im privaten Modus aktiv ist), Tabs einer kontextuellen Identität oder eine Kombination dieser zu registrieren. Siehe Arbeiten mit kontextuellen Identitäten für mehr Informationen.

css Optional

Ein Array von Objekten. Jedes Objekt hat entweder eine Eigenschaft namens file, die eine URL ist, beginnend beim Manifest.json der Erweiterung und auf eine zu registrierende CSS-Datei zeigend, oder eine Eigenschaft namens code, was etwas zu registrierender CSS-Code ist.

cssOrigin Optional

string. Der Stil-Ursprung für die Injektion, entweder "user", um das CSS als Benutzerstilblatt hinzuzufügen, oder "author", um es als Autorenstilblatt hinzuzufügen. Standard ist "author". Diese Eigenschaft ist nicht groß-/kleinschreibungsempfindlich.

excludeGlobs Optional

Entspricht exclude_globs im content_scripts Schlüssel.

excludeMatches Optional

Entspricht exclude_matches im content_scripts Schlüssel.

includeGlobs Optional

Entspricht include_globs im content_scripts Schlüssel.

js Optional

Ein Array von Objekten. Jedes Objekt hat entweder eine Eigenschaft namens file, die eine URL ist, beginnend beim Manifest.json der Erweiterung und auf eine zu registrierende JavaScript-Datei zeigend, oder eine Eigenschaft namens code, was etwas zu registrierender JavaScript-Code ist.

matchAboutBlank Optional

Entspricht match_about_blank im content_scripts Schlüssel.

matchOriginAsFallback Optional

Entspricht match_origin_as_fallback im content_scripts Schlüssel.

matches

Entspricht matches im content_scripts Schlüssel.

runAt Optional

Entspricht run_at im content_scripts Schlüssel.

world Optional

Die Ausführungsumgebung, in der ein Skript ausgeführt werden soll. Entspricht world im content_scripts Schlüssel.

Rückgabewert

Ein Promise, das mit einem contentScripts.RegisteredContentScript Objekt erfüllt wird, das Sie verwenden können, um die Inhaltsskripte abzumelden.

Derzeit werden Inhaltsskripte abgemeldet, wenn die zugehörige Erweiterungsseite (von der die Inhaltsskripte registriert wurden) entladen wird, daher sollten Sie ein Inhaltsskript von einer Erweiterungsseite registrieren, die mindestens so lange bestehen bleibt, wie Sie möchten, dass die Inhaltsskripte registriert bleiben.

Beispiele

Dieses Beispiel registriert das defaultCode Inhaltsskript für alle .org URLs:

const defaultHosts = "*://*.org/*";
const defaultCode =
  "document.body.innerHTML = '<h1>This page has been eaten<h1>'";

async function register(hosts, code) {
  return await browser.contentScripts.register({
    matches: [hosts],
    js: [{ code }],
    runAt: "document_idle",
  });
}

let registered = register(defaultHosts, defaultCode);

Dieser Code registriert die JS-Datei unter content_scripts/example.js:

const scriptObj = await browser.contentScripts.register({
  js: [{ file: "/content_scripts/example.js" }],
  matches: ["<all_urls>"],
  allFrames: true,
  runAt: "document_start",
});

Beispielerweiterungen

• content-script-register

Browser-Kompatibilität