browserAction.setTitle()

Définit le titre de l'action du navigateur. Le titre est affiché dans une infobulle au-dessus de l'icône de l'action du navigateur. Vous pouvez passer un tabId dans ou une windowId comme paramètre optionnel — si vous le faites, le titre est changé seulement pour l'onglet donné ou la fenêtre donnée. Les onglets ou les fenêtres sans titre spécifique hériteront du texte du titre global, qui est par défaut à l'option default_title ou name specifié dans le manifest.

Syntaxe

js
browser.browserAction.setTitle(
  details, // object
);

Paramètres

details

object. Le nouveau titre et éventuellement l'ID de l'onglet ou de la fenêtre à cibler.

title

string ou null. La chaîne de caractères que l'action du navigateur doit afficher lorsqu'il y a une souris.

Si title est une chaîne vide, le titre utilisé sera le nom de l'extension, mais browserAction.getTitle fournira toujours la chaîne vide.

Si title est null:

  • Si tabId est spécifié, et que l'onglet a un jeu de titres spécifiques aux onglets, alors l'onglet héritera du titre de la fenêtre à laquelle il appartient.
  • Si windowId est spécifié, et que la fenêtre a un titre spécifique à la fenêtre, alors la fenêtre héritera du titre global.
  • Sinon, le titre global sera réinitialisé au titre du manifest.
tabIdFacultatif

integer. Définit le titre uniquement pour l'onglet donné.

windowIdFacultatif

integer. Définit le titre de la fenêtre donnée.

  • Si windowId et tabId sont tous deux fournis, la fonction échoue et le titre n'est pas défini.
  • Si windowId et tabId sont tous les deux omis, le titre global est défini.

Exemples

Ce code change le titre entre "ceci" et "ça" chaque fois que l'utilisateur clique sur l'action du navigateur :

js
function toggleTitle(title) {
  if (title == "this") {
    browser.browserAction.setTitle({ title: "that" });
  } else {
    browser.browserAction.setTitle({ title: "this" });
  }
}

browser.browserAction.onClicked.addListener(() => {
  var gettingTitle = browser.browserAction.getTitle({});
  gettingTitle.then(toggleTitle);
});

Compatibilité des navigateurs

BCD tables only load in the browser

Example extensions

Note :

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.