Dieser Inhalt wurde automatisch aus dem Englischen übersetzt, und kann Fehler enthalten. Erfahre mehr über dieses Experiment.

View in English Always switch to English

options_ui

Typ Object
Verpflichtend Nein
Manifest-Version 2 oder höher
Beispiel
json
"options_ui": {
  "page": "options/options.html"
}

Verwenden Sie den Schlüssel options_ui, um eine Optionsseite für Ihre Erweiterung zu definieren. Diese Seite dient dazu, den Benutzern zu ermöglichen, die Einstellungen Ihrer Erweiterung zu ändern.

Die Methode, wie der Benutzer die Seite öffnet, ist browserabhängig und hängt auch von der Einstellung open_in_tab ab. Ihre Erweiterung kann die Seite auch über runtime.openOptionsPage() öffnen.

Sie geben options_ui als Pfad zu einer HTML-Datei an, die mit Ihrer Erweiterung verpackt ist. Die HTML-Datei kann CSS- und JavaScript-Dateien enthalten, genau wie eine normale Webseite. Im Gegensatz zu einer normalen Seite kann das JavaScript jedoch alle WebExtension-APIs verwenden, für die die Erweiterung Berechtigungen hat. Es läuft jedoch in einem anderen Kontext als Ihre Hintergrundskripte.

Wenn Sie Daten oder Funktionen direkt zwischen dem JavaScript auf Ihrer Optionsseite und Ihrem Hintergrundskript(en) teilen möchten, können Sie dies tun, indem Sie eine Referenz auf das Window Ihrer Hintergrundskripte über runtime.getBackgroundPage() oder eine Referenz auf das Window einer der innerhalb Ihrer Erweiterung laufenden Seiten über extension.getViews() erhalten. Alternativ können Sie zwischen dem JavaScript für Ihre Optionsseite und Ihrem Hintergrundskript(en) mit runtime.sendMessage(), runtime.onMessage, oder runtime.connect() kommunizieren. Letztere (oder die runtime.Port Äquivalente) können auch verwendet werden, um Optionen zwischen Ihrem Hintergrundskript(en) und Ihren Inhaltsskript(en). zu teilen.

Im Allgemeinen sollten Sie Optionen, die auf Optionsseiten geändert wurden, mit der storage API entweder in storage.sync (wenn Sie möchten, dass die Einstellungen über alle Instanzen dieses Browsers hinweg synchronisiert werden, in denen der Benutzer angemeldet ist) oder in storage.local (wenn die Einstellungen lokal auf dem aktuellen Rechner/Profil gespeichert werden sollen) speichern. Wenn Sie dies tun und Ihr Hintergrundskript(e) (oder Inhaltsskript(e)) über die Änderung informiert werden müssen, kann Ihr(e) Skript(e) einen Listener zu storage.onChanged hinzufügen.

Syntax

Der Schlüssel options_ui ist ein Objekt mit folgendem Inhalt:

Name Typ Beschreibung
browser_style
Optional
in Manifest V3.
Boolean

Optional, mit Standardwert:

  • true in Manifest V2 und vor Firefox 115 in Manifest V3.
  • false in Manifest V3 ab Firefox 115.

Setzen Sie browser_style nicht auf true: Es wird in Manifest V3 ab Firefox 118 nicht unterstützt. Siehe Manifest V3 Migration für browser_style.

In Firefox kann das Stylesheet unter chrome://browser/content/extension.css oder chrome://browser/content/extension-mac.css auf macOS eingesehen werden. Beim Festlegen von Abmessungen beachten Sie, dass dieses Stylesheet box-sizing: border-box setzt (siehe box-sizing).

open_in_tab
Optional
Boolean
  • Wenn false, öffnet sich die Optionsseite im Add-on-Manager des Browsers.
  • Wenn true, öffnet sich die Optionsseite in einem normalen Browser-Tab.

Standardwert ist false.

page String

Verpflichtend.

Der Pfad zu einer HTML-Datei, die die Spezifikation Ihrer Optionsseite enthält.

Der Pfad ist relativ zur Position der manifest.json selbst.

Beispiel

json
"options_ui": {
  "page": "options/options.html"
}

Browser-Kompatibilität

Siehe auch