UserScripts.UserScriptOptions (Legacy)

Warnung: Dies ist die Dokumentation für die veraltete API userScripts. Sie ist in Firefox für Manifest V2 verfügbar. Um Funktionen mit Benutzerskripten in Manifest V3 zu verwenden, siehe die neue userScripts API.

Das UserScriptOptions-Objekt repräsentiert die zu registrierenden Inhaltsskripte. Es hat eine ähnliche Syntax wie die contentScript-Optionen, die von browser.contentScripts.register unterstützt werden. Die Unterschiede sind:

  • Es unterstützt keine CSS-Eigenschaft (verwenden Sie browser.contentScripts.register, um Stylesheets dynamisch zu registrieren/abzumelden)
  • Es unterstützt eine optionale scriptMetadata-Eigenschaft (als einfaches JSON-Objekt, das einige Metadateneigenschaften enthält, die den registrierten userScripts zugeordnet sind)

Das UserScriptOptions-Objekt hat die folgenden Eigenschaften:

allFrames Optional

Entspricht all_frames im content_scripts-Schlüssel.

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, die im Manifest.json des Add-ons beginnt und auf eine zu registrierende JavaScript-Datei zeigt, oder eine Eigenschaft namens code, die JavaScript-Code zum Registrieren enthält.

matchAboutBlank Optional

Entspricht match_about_blank im content_scripts-Schlüssel.

matches

Entspricht matches im content_scripts-Schlüssel.

runAt Optional

Entspricht run_at im content_scripts-Schlüssel.

scriptMetadata Optional

Ein Benutzerskript-Metadatenwert.

Es hat eine ähnliche Syntax wie die contentScript-Optionen, die von browser.contentScripts.register unterstützt werden.