Type Objet
Obligatoire Non
Exemple
"sidebar_action": {
  "default_icon": {
    "16": "button/geo-16.png",
    "32": "button/geo-32.png"
  },
  "default_title": "Ma barre latérale !",
  "default_panel": "sidebar/sidebar.html"
}

Une barre latérale est un volet qui s'affiche à gauche de la fenêtre du navigateur, à côté de la page Web. Le navigateur fournit une interface qui permet à l'utilisateur de voir les barres latérales actuellement disponibles et de sélectionner celle à afficher.

La clé sidebar_action vous permet de définir les propriétés par défaut de la barre latérale. Vous pouvez modifier ces propriétés lors de l'exécution à l'aide de l'API sidebarAction.

Syntaxe

La clé sidebar_action est un objet qui peut avoir l'une des propriétés listées ci-dessous. La seule propriété obligatoire est default_panel.

Nom Type Description
browser_style Booléen

Facultatif, par défaut : true .

Utilisez cette option pour inclure une feuille de style dans votre fenêtre contextuelle qui permettra la correspondance avec l'interface utilisateur du navigateur et les autres extensions qui utilisent la propriété browser_style.

default_icon Objet ou Chaîne de caractères

Utilisez cette option pour spécifier une ou plusieurs icônes pour la barre latérale. L'icône est affichée dans l'interface utilisateur du navigateur pour l'ouverture et la fermeture des barres latérales.

Les icônes sont spécifiées comme des URL relatives au fichier manifest.json lui-même.

Vous pouvez spécifier un seul fichier d'icône en fournissant une chaîne ici :

"default_icon": "path/to/geo.svg"

Pour spécifier plusieurs icônes dans différentes tailles, spécifiez ici un objet. Le nom de chaque propriété est la hauteur de l'icône en pixels convertie en un nombre entier. La valeur est l'URL. Par exemple:

    "default_icon": {
      "16": "path/to/geo-16.png",
      "32": "path/to/geo-32.png"
    }

Voir Choix de la taille d'icones pour plus de conseils sur ce sujet.

Cette propriété est optionnelle : si elle est omise, la barre latérale n'obtient pas d'icône.

default_panel Chaîne de caractères

Le chemin d'accès à un fichier HTML qui spécifie le contenu de la barre latérale.

Le fichier HTML peut inclure des fichiers CSS et JavaScript à l'aide des éléments <link> et <script>, tout comme une page Web normale.

 Contrairement à une page Web normale, JavaScript en cours d'exécution dans le panneau peut accéder à toutes les APIs des WebExtension (à condition, bien sûr, que l'extension ait les permissions appropriées).

Cette propriété est obligatoire.

C'est une propriété localisable.

default_title String

Titre de la barre latérale. Ceci est utilisé dans l'interface utilisateur du navigateur pour la liste et l'ouverture des barres latérales, et s'affiche en haut de la barre latérale lorsqu'elle est ouverte.

Cette propriété est facultative : si elle est omise, le titre de la barre latérale est le nom de l'extension.

C'est une propriété localisable.

 

Exemple

"sidebar_action": {
  "default_icon": "sidebar.svg",
  "default_title": "Ma barre latérale !",
  "default_panel": "sidebar.html",
  "browser_style": true
}

Pour un exemple simple d'une extension qui utilise une barre latérale, regarder  annotate-page.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple Non Non54 Non (Oui)
browser_style Non Non55 Non Non

Étiquettes et contributeurs liés au document

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