browserAction.setTitle()

Legt den Titel der Browseraktion fest. Der Titel wird in einem Tooltip über dem Symbol der Browseraktion angezeigt. Sie können optional eine tabId oder eine windowId übergeben — wenn Sie dies tun, wird der Titel nur für den angegebenen Tab oder das angegebene Fenster geändert. Tabs oder Fenster ohne spezifischen Titel erben den globalen Titeltext, der standardmäßig dem default_title oder name entspricht, der im Manifest angegeben ist.

Syntax

js
browser.browserAction.setTitle(
  details // object
)

Parameter

details

object. Der neue Titel und optional die ID des Tabs oder Fensters, das angesprochen werden soll.

title

string oder null. Der Text, den die Browseraktion beim Überfahren mit der Maus anzeigen soll.

Wenn title eine leere Zeichenkette ist, wird der verwendete Titel der Name der Erweiterung sein, aber browserAction.getTitle wird dennoch die leere Zeichenkette ausgeben.

Wenn title null ist:

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

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

windowId Optional

integer. Setzt den Titel 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 wechselt den Titel zwischen "this" und "that" jedes Mal, wenn der Benutzer auf die Browseraktion klickt:

js
function toggleTitle(title) {
  if (title === "this") {
    browser.browserAction.setTitle({ title: "that" });
  } else {
    browser.browserAction.setTitle({ title: "this" });
  }
}

browser.browserAction.onClicked.addListener(() => {
  let gettingTitle = browser.browserAction.getTitle({});
  gettingTitle.then(toggleTitle);
});

Beispielerweiterungen

Hinweis: Diese API basiert auf der chrome.browserAction API von Chromium. Diese Dokumentation stammt aus browser_action.json im Chromium-Code.