action.setBadgeText()

Setzt den Badge-Text für die Browser-Action. Der Badge wird auf dem Icon angezeigt.

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

Tabs ohne spezifischen Badge-Text erben den globalen Badge-Text, der standardmäßig "" ist.

Syntax

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

Diese API ist auch als chrome.action.setBadgeText() verfügbar.

Parameter

details

Ein Objekt mit den folgenden Eigenschaften:

text

string oder null. Es können beliebig viele Zeichen übergeben werden, aber es passen nur etwa vier in den verfügbaren Platz.

Verwenden Sie einen leeren String - "" -, wenn Sie keinen Badge verwenden möchten.

Wenn eine tabId angegeben ist, entfernt null den Tab-spezifischen Badge-Text, sodass der Tab den globalen Badge-Text übernimmt. Andernfalls wird der globale Badge-Text auf "" zurückgesetzt.

Wenn eine windowId angegeben ist, entfernt null den fensterspezifischen Badge-Text, sodass der Tab den globalen Badge-Text übernimmt. Andernfalls wird der globale Badge-Text auf "" zurückgesetzt.

tabId Optional

integer. Setzt den Badge-Text nur für den angegebenen Tab. Der Text wird zurückgesetzt, wenn der Benutzer diesen Tab zu einer neuen Seite navigiert.

windowId Optional

integer. Setzt den Badge-Text für das angegebene Fenster.

  • Wenn sowohl windowId als auch tabId angegeben sind, schlägt die Funktion fehl.
  • Wenn sowohl windowId als auch tabId weggelassen werden, wird der globale Badge gesetzt.

Beispiele

Einen Badge hinzufügen, der anzeigt, wie oft der Benutzer den Button geklickt hat:

js
let clicks = 0;

function increment() {
  browser.action.setBadgeText({ text: (++clicks).toString() });
}

browser.action.onClicked.addListener(increment);

Browser-Kompatibilität

Hinweis: Diese API basiert auf Chromiums chrome.action API. Diese Dokumentation ist abgeleitet von browser_action.json im Chromium-Code.