browserAction.setBadgeText()

Définit le texte du badge pour l'action du navigateur. Le badge est affiché en haut de l'icône.

Les onglets sans texte de badge spécifique hériteront du texte global du badge, qui est "" par défaut.

Syntaxe

browser.browserAction.setBadgeText(
  details // object
)

Cette API est également disponible sous chrome.browserAction.setBadgeText().

Paramètres

details
object.
text

string or null. N'importe quel nombre de caractères peut être passé, mais seulement quatre environ peuvent tenir dans l'espace.

Utilisez une chaîne vide - "" - si vous ne voulez pas de badge.

Si un tabId est spécifié, null supprime le texte du badge spécifique à l'onglet afin que l'onglet hérite du texte global du badge. Dans le cas contraire, le texte du badge global devient "".

Si un windowId est spécifié, null supprime le texte du badge spécifique à la fenêtre afin que l'onglet hérite du texte global du badge. Dans le cas contraire, le texte du badge global devient "".

tabIdFacultatif
integer. Définir le texte du badge uniquement pour l'onglet donné. Le texte est réinitialisé lorsque l'utilisateur navigue dans cet onglet vers une nouvelle page.
windowIdFacultatif
integer. Définir le texte du badge pour la fenêtre donnée.
  • si windowId et tabId sont tous les deux fournis, la fonction échoue.
  • si windowId et tabId sont tous les deux omis, le badge global est défini.

Compatibilité du navigateur

BCD tables only load in the browser

Exemples

Ajouter un badge indiquant combien de fois l'utilisateur a cliqué sur le bouton : 

var clicks = 0;

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

browser.browserAction.onClicked.addListener(increment);

Example extensions

Remerciements :

Cette API est basée sur l'API Chromium chrome.browserAction. Cette documentation est dérivée de browser_action.json dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.