1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
---
title: sidebar_action
slug: Mozilla/Add-ons/WebExtensions/manifest.json/sidebar_action
tags:
- WebExtensions
translation_of: Mozilla/Add-ons/WebExtensions/manifest.json/sidebar_action
---
{{AddonSidebar}}
<table class="standard-table">
<tbody>
<tr>
<th scope="row" style="width: 30%">Type</th>
<td><code>Objet</code></td>
</tr>
<tr>
<th scope="row">Obligatoire</th>
<td>Non</td>
</tr>
<tr>
<th scope="row">Exemple</th>
<td>
<pre class="brush: json">
"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
}</pre
>
</td>
</tr>
</tbody>
</table>
Une [barre latérale](/fr/Add-ons/WebExtensions/Sidebars) 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 {{WebExtAPIRef("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`.
<table class="standard-table">
<thead>
<tr>
<th scope="col">Nom</th>
<th scope="col">Type</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code
><a
href="/fr/docs/Mozilla/Add-ons/WebExtensions/user_interface/Browser_styles"
>browser_style</a
></code
>
</td>
<td><code>Booléen</code></td>
<td>
<p>Facultatif, par défaut : <code>true</code> .</p>
<p>
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é <code>browser_style</code>.
</p>
<p>
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 <code>box-sizing: border-box</code> (see
<a href="/docs/Web/CSS/box-sizing">box-sizing</a>).
</p>
<p>
Le
<a href="https://firefoxux.github.io/StyleGuide/#/controls"
>guide de style de Firefox</a
>
décrit les classes que vous pouvez appliquer aux éléments de la barre
latérale afin d'obtenir des styles particuliers.
</p>
</td>
</tr>
<tr>
<td><code>default_icon</code></td>
<td><code>Objet</code> ou <code>Chaîne de caractères</code></td>
<td>
<p>
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.
</p>
<p>
Les icônes sont spécifiées comme des URL relatives au fichier
manifest.json lui-même.
</p>
<p>
Vous pouvez spécifier un seul fichier d'icône en fournissant une
chaîne ici :
</p>
<pre class="brush: json">"default_icon": "path/to/geo.svg"</pre>
<p>
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:
</p>
<pre class="brush: json">
"default_icon": {
"16": "path/to/geo-16.png",
"32": "path/to/geo-32.png"
}</pre
>
<p>
Voir
<a
href="/fr/Add-ons/WebExtensions/manifest.json/browser_action#Choosing_icon_sizes"
>Choix de la taille d'icones</a
>
pour plus de conseils sur ce sujet.
</p>
<p>
Cette propriété est optionnelle : si elle est omise, la barre latérale
n'obtient pas d'icône.
</p>
</td>
</tr>
<tr>
<td><code>default_panel</code></td>
<td><code>Chaîne de caractères</code></td>
<td>
<p>
Le chemin d'accès à un fichier HTML qui spécifie le contenu de la
barre latérale.
</p>
<p>
Le fichier HTML peut inclure des fichiers CSS et JavaScript à l'aide
des éléments
<code><a href="/fr/docs/Web/HTML/Element/link"><link></a></code>
et
<code
><a href="/fr/docs/Web/HTML/Element/script"><script></a></code
>, tout comme une page Web normale.
</p>
<p>
Contrairement à une page Web normale, JavaScript en cours d'exécution
dans le panneau peut accéder à toutes les
<a href="/fr/Add-ons/WebExtensions/API">APIs des WebExtension</a> (à
condition, bien sûr, que l'extension ait les
<a href="/fr/Add-ons/WebExtensions/manifest.json/permissions"
>permissions</a
>
appropriées).
</p>
<p>Cette propriété est obligatoire.</p>
<p>
C'est une
<a
href="/fr/Add-ons/WebExtensions/Internationalization#Internationalizing_manifest.json"
>propriété localisable</a
>.
</p>
</td>
</tr>
<tr>
<td><code>default_title</code></td>
<td><code>String</code></td>
<td>
<p>
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.
</p>
<p>
Cette propriété est facultative : si elle est omise, le titre de la
barre latérale est le
<code
><a href="/fr/Add-ons/WebExtensions/manifest.json/name"
>nom</a
></code
>
de l'extension.
</p>
<p>
C'est une
<a
href="/fr/Add-ons/WebExtensions/Internationalization#Internationalizing_manifest.json"
>propriété localisable.</a
>
</p>
</td>
</tr>
<tr>
<td><code>open_at_install</code></td>
<td>Boolean</td>
<td>
Facultatif, par défaut à <code>true</code>. 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.
</td>
</tr>
</tbody>
</table>
## Exemple
```json
"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](https://github.com/mdn/webextensions-examples/tree/master/annotate-page).
## Compatibilité du navigateur
{{Compat("webextensions.manifest.sidebar_action")}}
## Voir aussi
- [`browser_action`](/fr/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_action)
- [`page_action`](/fr/docs/Mozilla/Add-ons/WebExtensions/manifest.json/page_action)
- [Browser styles](/fr/docs/Mozilla/Add-ons/WebExtensions/user_interface/Browser_styles)
|
