options_ui
Typ | Object |
---|---|
Verpflichtend | Nein |
Manifest-Version | 2 oder höher |
Beispiel |
json
|
Verwenden Sie den Schlüssel options_ui
, um eine Optionsseite für Ihre Erweiterung zu definieren. Sie nutzen diese Seite, um Benutzern die Anpassung der Einstellungen Ihrer Erweiterung zu ermöglichen.
Die Art und Weise, 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 geliefert wird. 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 wird jedoch in einem anderen Umfang als Ihre Hintergrundskripte ausgeführt.
Wenn Sie Daten oder Funktionen zwischen dem JavaScript auf Ihrer Optionsseite und Ihrem Hintergrundskript(en) direkt teilen möchten, können Sie dies tun, indem Sie eine Referenz auf das Fenster Ihrer Hintergrundskripte mit extension.getBackgroundPage()
oder eine Referenz auf das Fenster
einer der Seiten innerhalb Ihrer Erweiterung mit 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 Äquivalente runtime.Port
) können auch verwendet werden, um Optionen zwischen Ihrem Hintergrundskript(en) und Ihren Inhaltsskript(en). zu teilen.
Im Allgemeinen sollten Sie die auf Optionsseiten geänderten Einstellungen mit der storage API entweder in storage.sync
(wenn Sie die Einstellungen über alle Instanzen dieses Browsers, in die der Benutzer eingeloggt ist, synchronisieren möchten) oder in storage.local
(wenn die Einstellungen lokal zu der aktuellen Maschine/Profil sind) speichern. Wenn Sie dies tun und Ihre Hintergrundskript(en) (oder Inhaltsskript(e)) von der Änderung erfahren müssen, könnte 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 Veraltet in Manifest V3. |
Boolean |
Optional, standardmäßig:
Setzen Sie
In Firefox kann das Stylesheet unter
|
open_in_tab Optional |
Boolean |
Standardmäßig |
page |
String |
Verpflichtend. Der Pfad zu einer HTML-Datei, die die Spezifikation Ihrer Optionsseite enthält.
Der Pfad ist relativ zur Position der
|
Beispiel
"options_ui": {
"page": "options/options.html"
}
Browser-Kompatibilität
Loading…
Siehe auch
options_page
Veraltet- Browser-Stile
- Optionsseiten