From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- .../api/sidebaraction/settitle/index.html | 125 +++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 files/fr/mozilla/add-ons/webextensions/api/sidebaraction/settitle/index.html (limited to 'files/fr/mozilla/add-ons/webextensions/api/sidebaraction/settitle/index.html') diff --git a/files/fr/mozilla/add-ons/webextensions/api/sidebaraction/settitle/index.html b/files/fr/mozilla/add-ons/webextensions/api/sidebaraction/settitle/index.html new file mode 100644 index 0000000000..7f6bf473c2 --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/sidebaraction/settitle/index.html @@ -0,0 +1,125 @@ +--- +title: sidebarAction.setTitle() +slug: Mozilla/Add-ons/WebExtensions/API/sidebarAction/setTitle +tags: + - API + - Add-ons + - Extensions + - Method + - Reference + - WebExtensions + - setTitle + - sidebarAction +translation_of: Mozilla/Add-ons/WebExtensions/API/sidebarAction/setTitle +--- +
{{AddonSidebar()}}
+ +

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 ou null. 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, mais {{WebExtAPIRef("sidebarAction.getTitle")}} fournira toujours la chaîne vide.

+ +

Si le titre est null, 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.
    • +
+
+
tabId{{optional_inline}}
+
integer. Définit le titre uniquement pour l'onglet donné.
+
windowId{{optional_inline}}
+
integer. Définit le titre uniquement pour la fenêtre donnée.
+
+
+
+ + + +

Compatibilité du navigateur

+ + + +

{{Compat("webextensions.api.sidebarAction.setTitle",2)}}

+ +

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);
+ +

{{WebExtExamples}}

+ +
Remerciements : + +

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

+
+ + -- cgit v1.2.3-54-g00ecf