action.setTitle()

Setzt den Titel der Browser-Aktion. Der Titel wird in einem Tooltip über dem Symbol der Browser-Aktion angezeigt. Sie können eine tabId oder eine windowId als optionalen Parameter ü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 dem im Manifest angegebenen name entspricht.

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 anvisiert 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 Erweiterungsname als Titel verwendet, aber action.getTitle wird weiterhin den leeren String anzeigen.

Wenn title null ist:

  • Wenn tabId angegeben ist und der Tab einen tab-spezifischen Titel hat, dann erbt der Tab den Titel des Fensters, zu dem es 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 im Manifest angegebenen Titel 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 werden, schlägt die Funktion fehl und der Titel wird nicht gesetzt.
  • Wenn windowId und tabId beide 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

Hinweis: Diese API basiert auf Chromiums chrome.action API. Diese Dokumentation stammt aus browser_action.json im Chromium-Code.