sidebarAction.setTitle()

Arten von Titeln

Ihre Erweiterung sollte im sidebar_action Manifest-Schlüssel einen Titel für die Seitenleiste angeben. Dies wird als "manifest title" bezeichnet. Wenn Sie keinen manifest title angeben, wird standardmäßig der Name der Erweiterung verwendet.

Wenn Sie mit setTitle() einen neuen Titel setzen und die Option tabId einfügen, dann wird der Titel nur für den angegebenen Tab gesetzt. Dieser Titel wird als "tab-specific title" bezeichnet.

Wenn Sie mit setTitle() einen neuen Titel setzen und die Option windowId einfügen, dann wird der Titel nur für das angegebene Fenster gesetzt. Dieser Titel wird als "window-specific title" bezeichnet und erscheint in allen Tabs dieses Fensters, die keinen tab-spezifischen Titel haben.

Wenn Sie mit setTitle() einen neuen Titel setzen und sowohl die Optionen tabId als auch windowId weglassen, dann wird dies als "global title" gesetzt. Der globale Titel erscheint dann in allen Tabs, die keinen tab-spezifischen Titel haben und deren Fenster keinen window-spezifischen Titel hat.

Syntax

browser.sidebarAction.setTitle(
  details // object
)

Parameter

details

object. Ein Objekt mit den folgenden Eigenschaften:

title

string oder null. Der neue Titel der Seitenleiste.

Wenn title ein leerer String ist, wird der verwendete Titel der Name der Erweiterung sein, aber sidebarAction.getTitle wird dennoch den leeren String liefern.

Wenn title null ist, wird ein zuvor gesetzter Titel entfernt, sodass:

• Wenn tabId angegeben ist und der Tab einen tab-spezifischen Titel hat, der Tab den Titel von dem Fenster übernimmt, zu dem er gehört.
• Wenn windowId angegeben ist und das Fenster einen window-spezifischen Titel hat, das Fenster den globalen Titel übernimmt.
• Andernfalls wird der globale Titel auf den manifest title zurückgesetzt.

tabId Optional

integer. Setzt den Titel nur für den angegebenen Tab.

windowId Optional

integer. Setzt den Titel nur für das angegebene Fenster.

• Wenn sowohl windowId als auch tabId angegeben sind, schlägt die Funktion fehl und der Titel wird nicht gesetzt.
• Wenn sowohl windowId als auch tabId weggelassen werden, wird der globale Titel gesetzt.

Beispiele

Dieser Code ändert den Titel der Seitenleiste, wenn der Benutzer auf eine Browser-Aktion klickt, jedoch nur für den aktuellen Tab:

let title = "A different title";

function setTitleForTab(tab) {
  browser.sidebarAction.setTitle({ title, tabId: tab.id });
}

browser.browserAction.onClicked.addListener(setTitleForTab);

Browser-Kompatibilität