MDN’s new design is in Beta! A sneak peek: https://blog.mozilla.org/opendesign/mdns-new-design-beta/

sidebar_action

Type Object
Obligatoire Non
Exemple
"sidebar_action": {
  "default_icon": {
    "16": "button/geo-16.png",
    "32": "button/geo-32.png"
  },
  "default_title": "My sidebar",
  "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 utilisateur qui permet à l'utilisateur de voir les barres latérales actuellement disponibles et de sélectionner une barre latérale à 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 à 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 suivantes, toutes les options :

Nom Type Description
browser_style Boolean

Facultatif, par défaut à TRUE.

Utilisez cette option pour inclure une feuille de style dans votre fenêtre contextuelle qui fera en sorte qu'elle corresponde à l'interface utilisateur du navigateur et à d'autres modules complémentaires qui utilisent la propriété browser_style.

default_icon Object ou String

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 et doit être converti 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"
    }

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

Cette proriété est optionnel : si elle est omise, la barre latérale n'obtient pas d'icone.

default_panel String

Le chemin d'accès à un fichier HTML que 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 (sujet, bien sür, à l'extension possédant 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 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": "My sidebar!",
  "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
Basic supportNoNo54NoYes
browser_styleNoNo55NoNo

Étiquettes et contributeurs liés au document

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