browserAction

Ajoute un bouton Ă  la barre d'outils du navigateur.

Une action du navigateur est un bouton dans la barre d'outils du navigateur.

Vous pouvez associer une fenĂȘtre contextuelle au bouton. La fenĂȘtre contextuelle est spĂ©cifĂ©e en utilisant HTML, CSS et JavaScript, tout comme une page Web normale. JavaScript en cours d'exĂ©cution dans le popup accĂšde Ă  toutes les mĂȘmes API WebExtension que vos scripts de fond, mais son contexte global est le popup, et non la page courrante affichĂ©e dans le navigateur. Pour effectuer les pages Web, vous devez communiquer avec eux par des messages.

Si vous spĂ©cifiez une fenĂȘtre contextuelle, elle sera affichĂ©e — et le contenu sera chargĂ© — quand l'utilisateur clique sur l'icĂŽne. Si vous ne spĂ©cifiez pas de fenĂȘtre contextuelle, alors lorsque l'utilisateur clique sur l'icĂŽne, un Ă©vĂ©nement est envoyĂ© Ă  votre extension.

Vous pouvez définir la plupart des propriétés d'une action de navigateur en utilisant la clé browser_action dans le manifest.json.

Quand l'API browserAction, vous pouvez :

  • Utiliser browserAction.onClicked pour Ă©couter les clics sur l'icĂŽne.
  • Obtenir et dĂ©finir les propriĂ©tĂ©s de l'icĂŽne — icĂŽne, titre, popup, etc. Vous pouvez les dĂ©finir globalement dans tous les onglets ou pour un onglet spĂ©cifique en passant l'ID de l'onglet comme un argument supplĂ©mentaire.

Types

browserAction.ColorArray
Un tableau de quatre nombres entiers entre 0-255 définie une couleur RGBA.
browserAction.ImageDataType
DonnĂ©es en pixels pour une image. Doit ĂȘtre un objet ImageData (par exemple, un Ă©lĂ©ment <canvas> ).

Fonctions

browserAction.setTitle()
Définit le titre de l'action du navigateur. Cela sera affiché dans une info-bulle.
browserAction.getTitle()
Obtient le titre de l'action du navigateur.
browserAction.setIcon()
DĂ©finit l'icĂŽne de l'action du navigateur.
browserAction.setPopup()
DĂ©finit le document HTML Ă  ouvrir en popup lorsque l'utilisateur clique  sur l'icĂŽne de l'action du navigateur.
browserAction.getPopup()
Permet de définir le document HTML en tant que popup de l'action du navigateur.
browserAction.openPopup()
Ouvrez le popup de l'action du navigateur.
browserAction.setBadgeText()
Définit le texte du badge de l'action du navigateur. Le badge est affiché en haut de l'icÎne.
browserAction.getBadgeText()
Obtient le texte du badge de l'action du navigateur.
browserAction.setBadgeBackgroundColor()
DĂ©finit la couleur de fond du badge.
browserAction.getBadgeBackgroundColor()
Obtient la couleur de fond du badge.
browserAction.setBadgeTextColor()
DĂ©finit la couleur du texte du badge.
browserAction.getBadgeTextColor()
Obtient la couleur du texte du badge.
browserAction.enable()
Active l'action du navigateur pour un onglet. Par défaut, les actions du navigateur sont activées pour tous les onglets.
browserAction.disable()
DĂ©sactive l'action du navigateur pour un onglet, ce qui signifie  qu'il ne peut pas ĂȘtre cliquĂ© lorsque cet onglet est actif.
browserAction.isEnabled()
Vérifie si l'action du navigateur est activée ou non.

Evénements

browserAction.onClicked
Action quand l'icone d'action du navigateur est cliquĂ©. Cet Ă©vĂ©nement ne dĂ©clenchera pas si l'action du navigateur comporte une fenĂȘtre contextuelle.

Compatibilité du navigateur

BCD tables only load in the browser

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.