blob: b6a83d61ddbbd11bf4254e903b998a1ea47b324a (
plain)
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
|
---
title: sidebarAction.isOpen()
slug: Mozilla/Add-ons/WebExtensions/API/sidebarAction/isOpen
tags:
- API
- Add-ons
- Extensions
- Method
- Reference
- WebExtensions
- isOpen
- slidebarAction
translation_of: Mozilla/Add-ons/WebExtensions/API/sidebarAction/isOpen
---
<div>{{AddonSidebar()}}</div>
<p>Renvoie <code>true</code> si la barre latérale de l'extension est ouverte dans une fenêtre donnée.</p>
<p>Cette fonction accepte un <code>windowId</code> en paramètre :</p>
<ul>
<li>Si vous fournissez <code>windowId</code>, la fonction vérifie la fenêtre du navigateur.</li>
<li>Si vous omettez <code>windowId</code>, la fonction vérifie la fenêtre du navigateur la plus haute.</li>
</ul>
<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">let gettingIsOpen = browser.sidebarAction.isOpen(
details // object
)
</pre>
<h3 id="Paramètres">Paramètres</h3>
<dl>
<dt><code>details</code></dt>
<dd><code>object</code>. Un objet contenant éventuellement le <code>windowId</code> à vérifier.</dd>
<dd>
<dl class="reference-values">
<dt><code>windowId</code> {{optional_inline}}</dt>
<dd><code>integer</code>. ID d'une fenêtre de navigateur à vérifier. Si omis par défaut, il s'agit de {{WebExtAPIRef("windows.WINDOW_ID_CURRENT")}}, qui fait référence à la fenêtre du navigateur la plus haute.</dd>
</dl>
</dd>
</dl>
<dl>
<dd>
<dl class="reference-values">
</dl>
</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 remplie avec <code>true</code> si la barre latérale de l'extension est ouverte dans la fenêtre donnée, ou <code>false</code> dans le cas contraire.</p>
<h2 id="Compatibilité_du_navigateur">Compatibilité du navigateur</h2>
<p>{{Compat("webextensions.api.sidebarAction.isOpen",2)}}</p>
<h2 id="Exemples">Exemples</h2>
<p>Vérifiez la fenêtre la plus haute :</p>
<pre class="brush: js">browser.sidebarAction.isOpen({}).then(result => {
console.log(result);
});</pre>
<p> Vérifiez toutes les fenêtres ouvertes :</p>
<pre class="brush: js">async function checkWindow(windowId) {
let result = await browser.sidebarAction.isOpen({windowId});
console.log(`window: ${windowId} status: ${result}`);
}
browser.windows.getAll().then(all => {
for (let {id} of all) {
checkWindow(id);
}
});</pre>
<p>{{WebExtExamples}}</p>
|
