diff options
Diffstat (limited to 'files/fr/mozilla/add-ons/webextensions/api/sidebaraction/setpanel/index.md')
| -rw-r--r-- | files/fr/mozilla/add-ons/webextensions/api/sidebaraction/setpanel/index.md | 118 |
1 files changed, 58 insertions, 60 deletions
diff --git a/files/fr/mozilla/add-ons/webextensions/api/sidebaraction/setpanel/index.md b/files/fr/mozilla/add-ons/webextensions/api/sidebaraction/setpanel/index.md index c2dbef6ee2..d7681c8ab3 100644 --- a/files/fr/mozilla/add-ons/webextensions/api/sidebaraction/setpanel/index.md +++ b/files/fr/mozilla/add-ons/webextensions/api/sidebaraction/setpanel/index.md @@ -12,61 +12,62 @@ tags: - sidebarAction translation_of: Mozilla/Add-ons/WebExtensions/API/sidebarAction/setPanel --- -<div>{{AddonSidebar()}}</div> +{{AddonSidebar()}} -<p>Définit le panneau de la barre latérale: c'est-à-dire le document HTML qui définit le contenu de cette barre latérale.</p> +Définit le panneau de la barre latérale: c'est-à-dire le document HTML qui définit le contenu de cette barre latérale. -<h2 id="Types_de_panneau">Types de panneau</h2> +## Types de panneau -<p>Les barres latérales ont toujours un <em>"panneau manifest"</em>, qui est le panneau défini dans la clé de manifest <code><a href="/fr/Add-ons/WebExtensions/manifest.json/sidebar_action">sidebar_action</a></code>.</p> +Les barres latérales ont toujours un _"panneau manifest"_, qui est le panneau défini dans la clé de manifest [`sidebar_action`](/fr/Add-ons/WebExtensions/manifest.json/sidebar_action). -<p>Si vous définissez un nouveau panneau à l'aide de <code>setPanel()</code>, et incluez l'option <code>tabId</code> le panneau est défini uniquement pour l'onglet donné. Ce panneau est appelé <em>"tab-specific panel"</em>.</p> +Si vous définissez un nouveau panneau à l'aide de `setPanel()`, et incluez l'option `tabId` le panneau est défini uniquement pour l'onglet donné. Ce panneau est appelé _"tab-specific panel"_. -<p>Si vous définissez un nouveau panneau en utilisant <code>setPanel()</code>, et incluez l'option <code>windowId</code>, alors le panneau n'est défini que pour la fenêtre donnée. Ce panneau est appelé <em>"panneau spécifique à la fenêtre"</em>, et apparaîtra dans tous les onglets de cette fenêtre qui n'ont pas d'ensemble de panneaux spécifiques aux onglets.</p> +Si vous définissez un nouveau panneau en utilisant `setPanel()`, et incluez l'option `windowId`, alors le panneau n'est défini que pour la fenêtre donnée. Ce panneau est appelé _"panneau spécifique à la fenêtre"_, et apparaîtra dans tous les onglets de cette fenêtre qui n'ont pas d'ensemble de panneaux spécifiques aux onglets. -<p>Si vous définissez un nouveau panneau en utilisant <code>setPanel()</code>, et omettez les options <code>tabId</code> et <code>windowId</code>, alors ceci définit le <em>"panneau global"</em>. Le panneau global apparaîtra alors dans tous les onglets qui n'ont pas d'ensemble de panneaux spécifiques aux onglets et dont la fenêtre n'a pas de panneau spécifique à une fenêtre.</p> +Si vous définissez un nouveau panneau en utilisant `setPanel()`, et omettez les options `tabId` et `windowId`, alors ceci définit le _"panneau global"_. Le panneau global apparaîtra alors dans tous les onglets qui n'ont pas d'ensemble de panneaux spécifiques aux onglets et dont la fenêtre n'a pas de panneau spécifique à une fenêtre. -<h2 id="Syntaxe">Syntaxe</h2> +## Syntaxe -<pre class="brush: js">browser.sidebarAction.setPanel( +```js +browser.sidebarAction.setPanel( details // object ) -</pre> - -<h3 id="Paramètres">Paramètres</h3> - -<dl> - <dt><code>details</code></dt> - <dd><p><code>object</code>. Un objet avec les propriétés suivantes :</p> - <dl> - <dt><code>panel</code></dt> - <dd><p><code>string</code> ou <code>null</code>. Le panneau à charger dans la barre latérale, spécifié comme une URL pointant vers un document HTML, ou <code>null</code>, ou une chaîne vide.</p> - <p>Ceci peut pointer vers un fichier empaqueté dans l'extension (for exemple, créé à l'aide de {{WebExtAPIRef("runtime.getURL")}}), ou un document distant (par exemple <code>https://example.org/</code>). Il doit s'agir d'une URL valide.</p> - <p>Si <code>panel</code> est <code>null</code> ou <code>""</code>,alors un panneau précédemment défini sera supprimé, de sorte que :</p> - <ul> - <li>Si <code>tabId</code> est spécifié, et que l'onglet a un jeu de panneaux spécifiques aux onglets, alors l'onglet héritera du panneau à partir de la fenêtre à laquelle il appartient.</li> - <li>Si <code>windowId</code> est spécifié, et que la fenêtre a un jeu de panneaux spécifiques à la fenêtre, alors la fenêtre héritera du panneau global.</li> - <li>Sinon, le panneau global sera réinitialisé au panneau manifest.</li> - </ul> - </dd> - <dt><code>tabId</code>{{optional_inline}}</dt> - <dd><code>integer</code>. Définit le panneau uniquement pour l'onglet donné.</dd> - <dt><code>windowId</code> {{optional_inline}}</dt> - <dd><code>integer</code>. Définit le panneau uniquement pour la fenêtre donnée.</dd> - </dl> - </dd> -</dl> - -<ul> - <li>Si <code>windowId</code> et <code>tabId</code> sont tous les deux spécifiés, la fonction échoue et le panneau n'est pas défini.</li> - <li>Si <code>windowId</code> et <code>tabId</code> sont tous les deux omis, le panneau global est défini.</li> -</ul> - -<h2 id="Exemples">Exemples</h2> - -<p>Ce code bascule le document de la barre latérale lorsque l'utilisateur clique sur une action du navigateur :</p> - -<pre class="brush: js">var thisPanel = browser.runtime.getURL("/this.html"); +``` + +### Paramètres + +- `details` + + - : `object`. Un objet avec les propriétés suivantes : + + - `panel` + + - : `string` ou `null`. Le panneau à charger dans la barre latérale, spécifié comme une URL pointant vers un document HTML, ou `null`, ou une chaîne vide. + + Ceci peut pointer vers un fichier empaqueté dans l'extension (for exemple, créé à l'aide de {{WebExtAPIRef("runtime.getURL")}}), ou un document distant (par exemple `https://example.org/`). Il doit s'agir d'une URL valide. + + Si `panel` est `null` ou `""`,alors un panneau précédemment défini sera supprimé, de sorte que : + + - Si `tabId` est spécifié, et que l'onglet a un jeu de panneaux spécifiques aux onglets, alors l'onglet héritera du panneau à partir de la fenêtre à laquelle il appartient. + - Si `windowId` est spécifié, et que la fenêtre a un jeu de panneaux spécifiques à la fenêtre, alors la fenêtre héritera du panneau global. + - Sinon, le panneau global sera réinitialisé au panneau manifest. + + - `tabId`{{optional_inline}} + - : `integer`. Définit le panneau uniquement pour l'onglet donné. + - `windowId` {{optional_inline}} + - : `integer`. Définit le panneau uniquement pour la fenêtre donnée. + +<!----> + +- Si `windowId` et `tabId` sont tous les deux spécifiés, la fonction échoue et le panneau n'est pas défini. +- Si `windowId` et `tabId` sont tous les deux omis, le panneau global est défini. + +## Exemples + +Ce code bascule le document de la barre latérale lorsque l'utilisateur clique sur une action du navigateur : + +```js +var thisPanel = browser.runtime.getURL("/this.html"); var thatPanel = browser.runtime.getURL("/that.html"); function toggle(panel) { @@ -77,26 +78,24 @@ function toggle(panel) { } } -browser.browserAction.onClicked.addListener(() => { +browser.browserAction.onClicked.addListener(() => { browser.sidebarAction.getPanel({}).then(toggle); }); -</pre> - -<p>{{WebExtExamples}}</p> - -<h2 id="Compatibilité_du_navigateur">Compatibilité du navigateur</h2> +``` -<p>{{Compat("webextensions.api.sidebarAction.setPanel",2)}}</p> +{{WebExtExamples}} -<div class="note"><p><strong>Note :</strong></p> +## Compatibilité du navigateur -<p>Cette API est basée sur l'API Opera <a href="https://dev.opera.com/extensions/sidebar-action-api/"><code>chrome.sidebarAction</code></a>.</p> +{{Compat("webextensions.api.sidebarAction.setPanel",2)}} -<p>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.</p> -</div> +> **Note :** +> +> Cette API est basée sur l'API Opera [`chrome.sidebarAction`](https://dev.opera.com/extensions/sidebar-action-api/). +> +> 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. -<div class="hidden"> -<pre>// Copyright 2015 The Chromium Authors. All rights reserved. +<div class="hidden"><pre>// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are @@ -123,5 +122,4 @@ browser.browserAction.onClicked.addListener(() => { // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -</pre> -</div> +</pre></div> |