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.