action.setTitle()

Setzt den Titel der Browser-Aktion. Der Titel wird in einem Tooltip über dem Symbol der Browser-Aktion angezeigt. Sie können einen tabId oder einen windowId als optionalen Parameter übergeben – wenn Sie dies tun, ändert sich der Titel nur für den angegebenen Tab oder das Fenster. Tabs oder Fenster ohne einen spezifischen Titel übernehmen den globalen Titeltext, der standardmäßig dem default_title oder name entspricht, der im Manifest angegeben ist.

Hinweis: Diese API ist in Manifest V3 oder höher verfügbar.

Syntax

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

Parameter

details

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

title

string oder null. Der String, den die Browser-Aktion anzeigen soll, wenn darübergefahren wird.

Wenn title ein leerer String ist, wird der verwendete Titel der Erweiterungsname sein, aber action.getTitle wird weiterhin den leeren String liefern.

Wenn title null ist:

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

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

windowId Optional

integer. Setzt den Titel für das gegebene 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 wechselt den Titel zwischen "this" und "that" jedes Mal, wenn der Benutzer auf die Browser-Aktion klickt:

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

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

Browser-Kompatibilität

BCD tables only load in the browser

Hinweis: Diese API basiert auf der chrome.action API von Chromium. Diese Dokumentation leitet sich von browser_action.json im Chromium-Code ab.