browserAction.setBadgeText()

Setzt den Badge-Text für die Browser-Aktion. Der Badge wird oberhalb des Symbols angezeigt.

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

Syntax

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

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

Parameter

details

Ein Objekt mit den folgenden Eigenschaften:

text

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

Verwenden Sie einen leeren String - "" - wenn Sie keinen Badge wünschen.

Wenn ein 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. Setzen Sie 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. Setzen Sie den Badge-Text für das angegebene Fenster.

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

Browser-Kompatibilität

BCD tables only load in the browser

Beispiele

Fügen Sie einen Badge hinzu, der anzeigt, wie oft der Benutzer den Button geklickt hat:

js
let clicks = 0;

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

browser.browserAction.onClicked.addListener(increment);

Beispielerweiterungen

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