diff options
Diffstat (limited to 'files/fr/mozilla/add-ons/webextensions/api/pageaction/seticon/index.html')
| -rw-r--r-- | files/fr/mozilla/add-ons/webextensions/api/pageaction/seticon/index.html | 130 |
1 files changed, 130 insertions, 0 deletions
diff --git a/files/fr/mozilla/add-ons/webextensions/api/pageaction/seticon/index.html b/files/fr/mozilla/add-ons/webextensions/api/pageaction/seticon/index.html new file mode 100644 index 0000000000..223ded5321 --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/pageaction/seticon/index.html @@ -0,0 +1,130 @@ +--- +title: pageAction.setIcon() +slug: Mozilla/Add-ons/WebExtensions/API/pageAction/setIcon +tags: + - API + - Add-ons + - Extensions + - Method + - Non-standard + - Reference + - WebExtensions + - pageAction + - setIcon +translation_of: Mozilla/Add-ons/WebExtensions/API/pageAction/setIcon +--- +<div>{{AddonSidebar()}}</div> + +<p>Définit l'icône de l'action de la page</p> + +<p>Vous pouvez spécifié un seule icône comme chemin d'accès à un fichier image ou un objet {{WebExtAPIRef('pageAction.ImageDataType')}}.</p> + +<p>Vous pouvez spécifier plusieurs icônes de différentes tailles en fournissant un dictionnaire contenant plusieurs chemins ou objets <code>ImageData</code>. Cela signifie que l'icône ne doit pas être mise à l'échelle pour un périphérique avec une densité de pixels différente.</p> + +<p>C'est une fonction asynchrone qui renvoie une <code><a href="/fr/docs/Web/JavaScript/Reference/Objets_globaux/Promise">Promise</a></code>.</p> + +<h2 id="Syntaxe">Syntaxe</h2> + +<pre class="syntaxbox brush:js">var settingIcon = browser.pageAction.setIcon( + details // object +) +</pre> + +<h3 id="Paramètres">Paramètres</h3> + +<dl> + <dt><code>details</code></dt> + <dd><code>object</code>. Un objet contenant les propriétés <code>imageData</code> ou <code>path</code> , et éventuellement une propriété <code>tabId</code>.</dd> + <dd> + <dl class="reference-values"> + <dt><code>imageData</code>{{optional_inline}}</dt> + <dd> + <p><code>{{WebExtAPIRef('pageAction.ImageDataType')}}</code> ou <code><code>object</code></code>. C'est un objet <code>ImageData</code> unique ou un dictionnaire d'objets.</p> + + <p>Utilisation un dictionnaire d'objets pour spécifier de multiple objets <code>ImageData</code> dans différentes tailles, de sorte que l'icône ne doit pas être mise à l'échelle pour un périphérique avec une densité de pixel différente. Si <code>imageData</code> est un dictionnaire, la valeur de chaque propriété est un objet <code>ImageData</code> , et le nom est sa taille, comme ceci :</p> + + <pre class="brush: json line-numbers language-json"><code class="language-json"><span class="punctuation token">{</span> + <span class="key token">16:</span> <span class="string token">image16</span><span class="punctuation token">,</span> + <span class="key token">32:</span> image32 +<span class="punctuation token">}</span></code></pre> + + <p>Le navigateur choisira l'image à utiliser en fonction de la densité de pixels de l'écran. Voir <a href="/fr/Add-ons/WebExtensions/manifest.json/browser_action#Choisir_la_tailles_des_icônes">Choisir les tailles d'icônes</a> pour plus d'informations à ce sujet.</p> + </dd> + <dt><code>path</code>{{optional_inline}}</dt> + <dd> + <p><code><code>string</code></code> ou <code><code>object</code></code>. C'est soit un chemin relatif vers un fichier icône ou objet dictionnaire. </p> + + <p>Utilisez un dictionnaire d'objets pour spécifier plusieurs fichiers d'icônes de différentes tailles, de sorte que l'icône ne doit pas être mise à l'échelle pour un périphérique avec une densité de pixels différente. Si <code>path</code> est un dictionnaire, la valeur de chaque propriété est un chemin relatif, et son nom est sa taille, comme ceci :</p> + + <pre class="brush: json line-numbers language-json"><code class="language-json"><span class="punctuation token">{</span> + <span class="key token">16:</span> "path/to/image16.jpg<span class="punctuation token">",</span> + <span class="key token">32:</span> "path/to/image32.jpg<span class="punctuation token">"</span> +<span class="punctuation token">}</span></code></pre> + + <p>Le navigateur choisira l'image à utiliser en fonction de la densité de pixels de l'écran. Voir <a href="/fr/Add-ons/WebExtensions/manifest.json/browser_action#Choisir_la_tailles_des_icônes">Choisir les tailles d'icônes</a> pour plus d'informations à ce sujet.</p> + </dd> + <dt><code>tabId</code></dt> + <dd><code>integer</code>. L'ID de l'onglet dont vous voulez définir l'icône.</dd> + </dl> + + <h3 id="Valeur_retournée">Valeur retournée</h3> + + <p>Une <code><a href="/fr/docs/Web/JavaScript/Reference/Objets_globaux/Promise">Promise</a></code> qui sera accompli sans arguments une fois l'icône définie.</p> + </dd> + <dd> + <h2 id="Compatibilité_du_navigateur">Compatibilité du navigateur</h2> + + <p class="hidden">The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</p> + {{Compat("webextensions.api.pageAction.setIcon")}} + + <h2 id="Exemples">Exemples</h2> + + <p>Définissez l'icône de l'action de la page lorsque l'utilisateur clique dessus :</p> + + <pre class="brush: js">browser.pageAction.onClicked.addListener((tab) => { + browser.pageAction.setIcon({ + tabId: tab.id, path: "icons/icon-48.png" + }); +});</pre> + + <p>{{WebExtExamples}}</p> + + <div class="note"><strong>Remerciements :</strong> + + <p>Cette API est basée sur l'API Chromium <a href="https://developer.chrome.com/extensions/pageAction"><code>chrome.pageAction</code></a>. Cette documentation est dérivée de <a href="https://chromium.googlesource.com/chromium/src/+/master/chrome/common/extensions/api/page_action.json"><code>page_action.json</code></a> dans le code de Chromium code.</p> + + <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> + + <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 +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// 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> + </dd> +</dl> |
