sidebarAction.setTitle()

Setzt den Titel der Seitenleiste. Der Titel wird überall angezeigt, wo der Browser verfügbare Seitenleisten auflistet. Zum Beispiel zeigt Firefox ihn im Menü "Ansicht > Seitenleiste" an. Er wird auch oben in der Seitenleiste angezeigt, wenn diese geöffnet ist.

Arten von Titeln

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

Wenn Sie einen neuen Titel mit setTitle() setzen und die tabId-Option einschließen, wird der Titel nur für den angegebenen Tab gesetzt. Dieser Titel wird als "tab-spezifischer Titel" bezeichnet.

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

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

Syntax

js
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, jedoch liefert sidebarAction.getTitle trotzdem den leeren String.

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

  • Wenn tabId angegeben ist und der Tab einen tab-spezifischen Titel hat, erbt der Tab den Titel des Fensters, zu dem er gehört.
  • Wenn windowId angegeben ist und das Fenster einen fensterspezifischen Titel hat, erbt das Fenster den globalen Titel.
  • Andernfalls wird der globale Titel auf den Manifest-Titel 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.

Browser-Kompatibilität

BCD tables only load in the browser

Beispiele

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

js
let title = "A different title";

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

browser.browserAction.onClicked.addListener(setTitleForTab);

Hinweis: Diese API basiert auf der chrome.sidebarAction API von Opera.