Obtient et définit les propriétés de la barre latérale d'une extension.

Une barre latérale est un volet qui s'affiche à gauche ou à droite de la fenêtre du navigateur, à côté de la page Web. Le navigateur fournit une interface utilisateur qui permet à l'utilisateur de voir les barres latérales actuellement disponibles et de sélectionner une barre latérale à afficher. En utilisant la clé sidebar_action manifest.json, une extension peut définir sa propre barre latérale.
En utilisant l'API sidebarAction décrite ici, une extension peut obtenir et définir les propriétés de la barre latérale.

L'API sidebarAction est étroitement modélisée sur l'API  browserAction.

L'API sidebarAction est basée sur l'API sidebarAction d'Opéra. Toutefois, notez que les éléments suivants ne sont pas encore pris en charge : setBadgeText(), getBadgeText(), setBadgeBackgroundColor(), getBadgeBackgroundColor(), onFocus, onBlur.

Types

sidebarAction.ImageDataType
Données de pixel pour une image. Doit être un objet ImageData (par exemple, à partir d'un élément <canvas>).

Fonctions

sidebarAction.setPanel()
Définit le panneau de la barre latérale.
sidebarAction.getPanel()
Obtient le panneau de la barre latérale.
sidebarAction.setTitle()
Définit le titre de la barre latérale. Ceci sera affiché dans n'importe quelle interface utilisateur fournie par le navigateur pour lister les barres latérales, comme un menu.
sidebarAction.getTitle()
Obtient le titre de la barre latérale.
sidebarAction.setIcon()
Définit l'icône de la barre latérale.
sidebarAction.open()
Ouvre la barre latérale.
sidebarAction.close()
Ferme la barre latérale.
sidebarAction.isOpen()
Vérifie si la barre latérale est ouverte ou non.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
ImageDataType Non Non54 Non Oui
close Non Non57 Non Non
getPanel Non Non54 Non Oui
getTitle Non Non54 Non Oui
isOpen Non Non59 Non Non
open Non Non57 Non Non
setIcon Non Non54 Non Oui
setPanel Non Non54 Non Oui
setTitle Non Non54 Non Oui

Exemple extensions

Remerciements :

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

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.

Étiquettes et contributeurs liés au document

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