blob: fe3901c4a883c13537fdab480573c4291a4e02b3 (
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
85
86
87
88
89
90
91
92
93
|
---
title: 地址栏按钮
slug: Mozilla/Add-ons/WebExtensions/user_interface/Page_actions
translation_of: Mozilla/Add-ons/WebExtensions/user_interface/Page_actions
---
<div>{{AddonSideBar}}</div>
<div>通常来说的page action,是添加到浏览器地址栏中的按钮。用户通过点击这个按钮与你的扩展进行交互。</div>
<p><img alt="" src="https://mdn.mozillademos.org/files/15745/address_bar_button.png" style="display: block; height: 174px; margin-left: auto; margin-right: auto; width: 350px;"></p>
<h2 id="地址栏按钮(Page_actions)和工具栏按钮(_browser_actions)">地址栏按钮(Page actions)和工具栏按钮( browser actions)</h2>
<p>地址栏按钮(或 page action) 与工具栏按钮(或 browser action)非常相似。</p>
<p>其不同之处为:</p>
<ul>
<li>位置:
<ul>
<li>地址栏按钮是显示在浏览器的地址栏内;</li>
<li>工具栏按钮不是显示在地址栏内,而是在浏览器的工具栏上。</li>
</ul>
</li>
<li>可见性:
<ul>
<li>地址栏按钮默认是隐藏的(尽管可以通过manifest中“show_matches和hide_matches来改变),而你可以在特定tabs中调用pageAction.show()和pageAction.hide()来显示或隐藏它。</li>
<li>工具栏按钮总是可见的。</li>
</ul>
</li>
</ul>
<p>当动作(行为)与当前页面关联时,使用地址栏按钮,而当动作(行为)与浏览器相关或与多个页面相关时使用工具栏按钮。例如:</p>
<table class="fullwidth-table standard-table">
<thead>
<tr>
<th scope="row">类型</th>
<th scope="col">书签动作</th>
<th scope="col">内容动作</th>
<th scope="col">标签操作</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">page action</th>
<td>将本页面保存到书签</td>
<td>Reddit enhancement</td>
<td>Send tab</td>
</tr>
<tr>
<th scope="row">browser action</th>
<td>显示所有书签</td>
<td>使能ad-blocking</td>
<td>同步所有打开的标签</td>
</tr>
</tbody>
</table>
<p> </p>
<h2 id="定义地址栏按钮">定义地址栏按钮</h2>
<p>你可以在manifest.json中使用page_action键定义地址栏按钮的属性:</p>
<pre class="brush: json line-numbers language-json"><code class="language-json"><span class="key token">"page_action":</span> <span class="punctuation token">{</span>
<span class="key token">"browser_style":</span> <span class="keyword token">true</span><span class="punctuation token">,</span>
<span class="key token">"default_icon":</span> <span class="punctuation token">{</span>
<span class="key token">"19":</span> <span class="string token">"button/geo-19.png"</span><span class="punctuation token">,</span>
<span class="key token">"38":</span> <span class="string token">"button/geo-38.png"</span>
<span class="punctuation token">}</span><span class="punctuation token">,</span>
<span class="key token">"default_title":</span> <span class="string token">"Whereami?"</span>
<span class="punctuation token">}</span></code></pre>
<p>仅default_icon是强制(必需)的。</p>
<p>有两种方式定义地址栏按钮:带popup窗口和无popup窗口。如果你没有指定一个popup,则当用户点击此按钮时,事件被派送到使用<a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/pageAction/onClicked">pageAction.onClicked</a>侦听器的扩展:</p>
<pre class="brush: js line-numbers language-js"><code class="language-js">browser<span class="punctuation token">.</span>pageAction<span class="punctuation token">.</span>onClicked<span class="punctuation token">.</span><span class="function token">addListener</span><span class="punctuation token">(</span>handleClick<span class="punctuation token">)</span><span class="punctuation token">;</span></code></pre>
<p>如果你指定了一个popup,则点击事件不被派送,在用户点击按钮时显示popup。用户可以与popup进行交互,并且当用户点击popup以外区域时,popup自动关闭。参见<a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Popups">Popup</a>可获得创建和管理popups更详细内容。</p>
<p>注意你的扩展只能有一个地址栏按钮。</p>
<p>通过使用<a href="https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/pageAction">pageAction</a> API,你可以以编程方式修改地址栏按钮的任何属性。</p>
<h2 id="Icons">Icons</h2>
<p>如何创建用于地址栏按钮的ICONS的详细内容,请参见<a href="https://design.firefox.com/photon/index.html">Photon Design System</a>文档中的<a href="https://design.firefox.com/photon/visuals/iconography.html">Iconography</a>节。</p>
<h2 id="示例">示例</h2>
<p>GitHub上的 <a href="https://github.com/mdn/webextensions-examples">webextensions-examples</a> 库中包括了实现无popup地址栏按钮的例子 <a href="https://github.com/mdn/webextensions-examples/tree/master/chill-out">chill-out</a> 。</p>
|