Modules

sidebarAction.setTitle()

Définit le titre de la barre latérale. Le titre est affiché partout où le navigateur affiche les barres latérales disponibles. Par exemple, Firefox le montrera dans le menu "View > Barre latérale". Il est également affiché en haut de la barre latérale lorsque la barre latérale est ouverte.

Vous pouvez passer un tabId en tant que paramètre facultatif. Si vous faites cela, le titre est modifié uniquement pour l'onglet donné.

Types de titres

Votre extension doit spécifier un titre pour la barre latérale dans la clé de manifest  sidebar_action. C'est ce qu'on appelle le "titre du manifest".

ISi vous ne spécifiez pas de titre dans la clé sidebar_action, son titre est le nom de l'extension. C'est ce qu'on appelle le "titre par default".

Si vous définissez un nouveau titre à l'aide de setTitle(), et incluez l'option tabId le titre est défini uniquement pour l'onglet donné. Ce titre est appelé "titre tab-specific".

Si vous définissez un nouveau titre à l'aide de setTitle(), et omettez l'option tabId de setTitle(), cela définit le "titre global". Le titre global apparaîtra alors dans tous les onglets qui n'ont pas de jeu de titres spécifique à l'onglet.

Syntaxe

browser.sidebarAction.setTitle(
  details // object
)

Paramètres

details
object. Le nouveau titre et éventuellement l'identifiant de l'onglet à cibler.
title
string ou null. Le nouveau titre de la barre latérale.

si le titre est une chaîne vide, le titre sera réinitialisé au titre par défaut.

Si le titre est null, et que tabId a été spécifié et que l'onglet spécifié possède un jeu de titres spécifique à l'onglet : le titre spécifique à l'onglet est réinitialisé au titre global (si un titre global est défini) ou au titre du manifest.

Si le titre est null, et tabId a été omis, et qu'il y avait un ensemble de titres global, il sera réinitialisé au titre du manifest.

tabIdFacultatif
integer. Définit le titre uniquement pour l'onglet donné. Le titre est réinitialisé automatiquement lorsque l'onglet est fermé.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple Non Non54 Non Oui
The title property of the details parameter can be set to null. Non Non59 Non Non
details.windowId Non Non61 Non Non

Exemples

Ce code modifie le titre de la barre latérale lorsque l'utilisateur clique sur une action du navigateur, mais uniquement pour l'onglet en cours :

var title = "A different title";

function setTitleForTab(tab) {
  browser.sidebarAction.setTitle({title, tabId: tab.id});    
}

browser.browserAction.onClicked.addListener(setTitleForTab);

Remerciements :

Cette API est basée sur l'API Opera chrome.sidebarAction.

Étiquettes et contributeurs liés au document

Contributeurs à cette page : hellosct1
Dernière mise à jour par : hellosct1,