action.setBadgeBackgroundColor()

Legt die Hintergrundfarbe für das Badge fest. Tabs ohne eine spezifische Hintergrundfarbe des Badges erben die globale Hintergrundfarbe des Badges, die in Firefox standardmäßig [217, 0, 0, 255] ist.

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

In Firefox wird, sofern die Textfarbe des Badges nicht explizit mit action.setBadgeTextColor() festgelegt wird, die Textfarbe des Badges automatisch auf Schwarz oder Weiß gesetzt, um den Kontrast zur angegebenen Hintergrundfarbe des Badges zu maximieren. Wenn Sie zum Beispiel die Hintergrundfarbe des Badges auf Weiß setzen, wird die standardmäßige Textfarbe des Badges auf Schwarz gesetzt und umgekehrt.

Andere Browser verwenden immer eine weiße Textfarbe, daher kann es vorzuziehen sein, eine dunkle Hintergrundfarbe zu setzen, um sicherzustellen, dass der Text lesbar ist.

Syntax

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

Parameter

details

Ein Objekt mit den folgenden Eigenschaften:

color

Die Farbe, angegeben als eine der folgenden Möglichkeiten:

  • ein String: jeder CSS <color> Wert, zum Beispiel "red", "#FF0000", oder "rgb(255 0 0)". Wenn der String keine gültige Farbe darstellt, wird das zurückgegebene Versprechen abgelehnt und die Hintergrundfarbe wird nicht verändert.
  • ein action.ColorArray Objekt.
  • null. Wenn ein tabId angegeben wird, entfernt es die spezifische Hintergrundfarbe des Badges für diesen Tab, sodass der Tab die globale Hintergrundfarbe des Badges erbt. Andernfalls wird die globale Hintergrundfarbe des Badges auf den Standardwert zurückgesetzt.
tabId Optional

integer. Setzt die Hintergrundfarbe des Badges nur für den angegebenen Tab. Die Farbe wird zurückgesetzt, wenn der Benutzer diesen Tab zu einer neuen Seite navigiert.

windowId Optional

integer. Setzt die Hintergrundfarbe des Badges nur für das angegebene Fenster.

  • Wenn sowohl windowId als auch tabId angegeben werden, schlägt die Funktion fehl und die Farbe wird nicht gesetzt.
  • Wenn sowohl windowId als auch tabId weggelassen werden, wird stattdessen die globale Hintergrundfarbe des Badges gesetzt.

Beispiele

Eine Hintergrundfarbe, die zunächst rot ist und grün wird, wenn die Browseraktion angeklickt wird:

js
browser.action.setBadgeText({ text: "1234" });
browser.action.setBadgeBackgroundColor({ color: "red" });

browser.action.onClicked.addListener(() => {
  browser.action.setBadgeBackgroundColor({ color: "green" });
});

Setzt die Hintergrundfarbe des Badges nur für den aktiven Tab:

js
browser.action.setBadgeText({ text: "1234" });
browser.action.setBadgeBackgroundColor({ color: "red" });

browser.action.onClicked.addListener((tab) => {
  browser.action.setBadgeBackgroundColor({
    color: "green",
    tabId: tab.id,
  });
});

Browser-Kompatibilität

Die Standardfarbe in Firefox ist: [217, 0, 0, 255].

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