action.setBadgeText()

Syntax

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 kann eine beliebige Anzahl von Zeichen übergeben werden, aber nur etwa vier passen in den verfügbaren Platz.

Verwenden Sie eine leere Zeichenfolge – "" –, wenn Sie kein Badge möchten.

Wenn eine tabId angegeben ist, entfernt null den tabspezifischen Badgetext, sodass der Tab den globalen Badgetext übernimmt. Andernfalls wird der globale Badgetext auf "" zurückgesetzt.

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

Ab Chrome 152 wird Badgetext mit mehr als 100 Bytes abgelehnt. Andere Browser können diese Begrenzung implementieren. Weitere Informationen finden Sie unter Vorschlag: Byte-Länge des Badgetexts für Erweiterungsaktionen begrenzen.

tabId Optional

integer. Legt den Badgetext nur für den angegebenen Tab fest. Der Text wird zurückgesetzt, wenn der Benutzer in diesem Tab zu einer neuen Seite navigiert.

windowId Optional

integer. Legt den Badgetext für das angegebene Fenster fest.

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

Beispiele

Fügen Sie ein Badge hinzu, das angibt, wie oft der Benutzer auf die Schaltfläche geklickt hat:

let clicks = 0;

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

browser.action.onClicked.addListener(increment);

Browser-Kompatibilität