browserAction.setTitle()

Setzt den Titel der Browser-Aktion. Der Titel wird in einem Tooltip über dem Icon 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 einen spezifischen Titel erben den globalen Titeltext, der standardmäßig dem default_title oder name entspricht, wie im Manifest angegeben.

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 String, der angezeigt werden soll, wenn die Maus über die Browser-Aktion bewegt wird.

Wenn title eine leere Zeichenkette ist, wird der Erweiterungsname als Titel verwendet, aber browserAction.getTitle liefert dennoch die leere Zeichenkette.

Wenn title null ist:

  • Wenn tabId angegeben ist und der Tab einen tab-spezifischen Titel gesetzt hat, wird der Tab den Titel vom Fenster erben, zu dem er gehört.
  • Wenn windowId angegeben ist und das Fenster einen fensterspezifischen Titel gesetzt hat, wird das Fenster den globalen Titel erben.
  • 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 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

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.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 Chromiums chrome.browserAction API. Diese Dokumentation ist abgeleitet von browser_action.json im Chromium-Code.