Type Objet
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",
  "open_at_install":true
}

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.

Dans Firefox, la feuille de style peut être vue sur  chrome://browser/content/extension.css, ou chrome://browser/content/extension-mac.css sur OS X. Lors de la définition des dimensions, savez que cette feiulle de style est actuellement définit box-sizing: border-box (see box-sizing).

Le guide de style de Firefox décrit les classes que vous pouvez appliquer aux éléments de la barre latérale afin d'obtenir des styles particuliers.

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.

open_at_install Boolean Facultatif, par défaut à true. Détermine si la barre latérale doit s'ouvrir lors de l'installation. Le comportement par defaut est d'ouvrir la barre latérale lorsque l'installation est terminée.

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

Update compatibility data on GitHub
OrdinateurMobile
ChromeEdgeFirefoxOperaFirefox pour Android
Support simpleChrome Aucun support NonEdge Aucun support NonFirefox Support complet 54Opera Support complet 30Firefox Android Aucun support Non
browser_styleChrome Aucun support NonEdge Aucun support NonFirefox Support complet 55Opera Aucun support NonFirefox Android Aucun support Non
open_at_installChrome Aucun support NonEdge Aucun support NonFirefox Support complet 62Opera Aucun support NonFirefox Android Aucun support Non

Légende

Support complet  
Support complet
Aucun support  
Aucun support

Voir aussi

Étiquettes et contributeurs liés au document

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