sidebarAction.setTitle()
Définit le titre de la barre latérale. Le titre est affiché n'importe où dans les barres latérales du navigateur. Par exemple, Firefox l'affichera dans le menu "Affichage > Barre latérale". Il est également affiché en haut de la barre latérale lorsque la barre latérale est ouverte.
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". Si vous ne spécifiez pas le titre du manifest, il sera par défaut le nom de l'extension
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 spécifique à l'onglet".
Si vous définissez un nouveau titre à l'aide de setTitle()
, et incluez l'option windowId
, alors le titre est défini uniquement pour la fenêtre donnée. Ce titre est appelé "titre spécifique à la fenêtre", et apparaîtra dans tous les onglets de cette fenêtre qui n'ont pas de titre spécifique à un onglet.
Si vous définissez un nouveau titre à l'aide de setTitle()
, et omettre les options tabId
et windowId
, alors ceci définit le "titre global". Le titre global apparaîtra alors dans tous les onglets qui n'ont pas de titre spécifique à un onglet et dont la fenêtre n'a pas de titre spécifique à une fenêtre.
Syntaxe
browser.sidebarAction.setTitle(
details, // object
);
Paramètres
details
-
object
. Un objet avec les propriétés suivantes .title
-
string
ounull
. Le nouveau titre de la barre latérale.si le
titre
est une chaîne vide, le titre utilisé sera le nom de l'extension, maissidebarAction.getTitle
fournira toujours la chaîne vide.Si le
titre
estnull
, alors un titre précédemment défini sera supprimé, de sorte que :- 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.
- Si
tabId
Facultatif-
integer
. Définit le titre uniquement pour l'onglet donné. windowId
Facultatif-
integer
. Définit le titre uniquement pour la fenêtre donnée.
- Si
windowId
ettabId
sont tous deux fournis, la fonction échoue et le titre n'est pas défini. - SI
windowId
ettabId
sont tous les deux omis, le titre global est définit.
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);
Compatibilité des navigateurs
BCD tables only load in the browser
Note :
Cette API est basée sur l'API Opera chrome.sidebarAction
.