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
|
---
title: browserAction
slug: Mozilla/Add-ons/WebExtensions/API/browserAction
translation_of: Mozilla/Add-ons/WebExtensions/API/browserAction
---
<div>{{AddonSidebar}}</div>
<p>מוסיף כפתור לסרגל הכלים של הדפדפן.</p>
<p> <a href="/he/docs/Mozilla/Add-ons/WebExtensions/Browser_action">פעולת דפדפן</a> הינה כפתור בסרגל הכלים של הדפדפן.</p>
<p>ניתן לקשר חלון קופץ עם הכפתור. החלון הקופץ מצויין באמצעות HTML, CSS וג'אווה-סקריפט , בדומה לדף רשת רגיל. לקוד ג'אווה-סקריפט המורץ בחלון הקופץ גישה לכל ממשקי פיתוח היישומים של הרחבת הרשת כמו תסריטי הרקע שלך, אך ההקשר הגלובלי שלו הוא החלון הקופץ, ולא הדף הנוכחי המוצג על ידי הדפדפן. כדי להספיע לע הדפים מהרשת יש לתקשר איתם דרך <a href="/en-US/Add-ons/WebExtensions/Modify_a_web_page#Messaging">messages</a>.</p>
<p>If you specify a popup, it will be shown — and the content will be loaded — when the user clicks the icon. If you do not specify a popup, then when the user clicks the icon an event is dispatched to your extension.</p>
<p>You can define most of a browser action's properties declaratively using the <code><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_action">browser_action</a></code> key in the manifest.json.</p>
<p>With the <code>browserAction</code> API, you can:</p>
<ul>
<li>use {{WebExtAPIRef("browserAction.onClicked")}} to listen for clicks on the icon.</li>
<li>get and set the icon's properties — icon, title, popup, and so on. You can get and set these globally across all tabs, or for a specific tab by passing the tab ID as an additional argument.</li>
</ul>
<h2 id="Types">Types</h2>
<dl>
<dt>{{WebExtAPIRef("browserAction.ColorArray")}}</dt>
<dd>An array of four integers in the range 0-255 defining an RGBA color.</dd>
<dt>{{WebExtAPIRef("browserAction.ImageDataType")}}</dt>
<dd>Pixel data for an image. Must be an <code><a href="/en-US/docs/Web/API/ImageData">ImageData</a></code> object (for example, from a {{htmlelement("canvas")}} element).</dd>
</dl>
<h2 id="Functions">Functions</h2>
<dl>
<dt>{{WebExtAPIRef("browserAction.setTitle()")}}</dt>
<dd>Sets the browser action's title. This will be displayed in a tooltip.</dd>
<dt>{{WebExtAPIRef("browserAction.getTitle()")}}</dt>
<dd>Gets the browser action's title.</dd>
<dt>{{WebExtAPIRef("browserAction.setIcon()")}}</dt>
<dd>Sets the browser action's icon.</dd>
<dt>{{WebExtAPIRef("browserAction.setPopup()")}}</dt>
<dd>Sets the HTML document to be opened as a popup when the user clicks on the browser action's icon.</dd>
<dt>{{WebExtAPIRef("browserAction.getPopup()")}}</dt>
<dd>Gets the HTML document set as the browser action's popup.</dd>
<dt>{{WebExtAPIRef("browserAction.openPopup()")}}</dt>
<dd>Open the browser action's popup.</dd>
<dt>{{WebExtAPIRef("browserAction.setBadgeText()")}}</dt>
<dd>Sets the browser action's badge text. The badge is displayed on top of the icon.</dd>
<dt>{{WebExtAPIRef("browserAction.getBadgeText()")}}</dt>
<dd>Gets the browser action's badge text.</dd>
<dt>{{WebExtAPIRef("browserAction.setBadgeBackgroundColor()")}}</dt>
<dd>Sets the badge's background color.</dd>
<dt>{{WebExtAPIRef("browserAction.getBadgeBackgroundColor()")}}</dt>
<dd>Gets the badge's background color.</dd>
<dt>{{WebExtAPIRef("browserAction.setBadgeTextColor()")}}</dt>
<dd>Sets the badge's text color.</dd>
<dt>{{WebExtAPIRef("browserAction.getBadgeTextColor()")}}</dt>
<dd>Gets the badge's text color.</dd>
<dt>{{WebExtAPIRef("browserAction.enable()")}}</dt>
<dd>Enables the browser action for a tab. By default, browser actions are enabled for all tabs.</dd>
<dt>{{WebExtAPIRef("browserAction.disable()")}}</dt>
<dd>Disables the browser action for a tab, meaning that it cannot be clicked when that tab is active.</dd>
<dt>{{WebExtAPIRef("browserAction.isEnabled()")}}</dt>
<dd>Checks whether the browser action is enabled or not.</dd>
</dl>
<h2 id="Events">Events</h2>
<dl>
<dt>{{WebExtAPIRef("browserAction.onClicked")}}</dt>
<dd>Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.</dd>
</dl>
<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>{{Compat("webextensions.api.browserAction")}}</p>
<div class="hidden note">
<p>The "Chrome incompatibilities" section is included from <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities"> https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities</a> using the <a href="/en-US/docs/Template:WebExtChromeCompat">WebExtChromeCompat</a> macro.</p>
<p>If you need to update this content, edit <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities">https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities</a>, then shift-refresh this page to see your changes.</p>
</div>
<p>{{WebExtExamples("h2")}}</p>
<div class="note"><strong>Acknowledgements</strong>
<p>This API is based on Chromium's <a href="https://developer.chrome.com/extensions/browserAction"><code>chrome.browserAction</code></a> API. This documentation is derived from <a href="https://chromium.googlesource.com/chromium/src/+/master/chrome/common/extensions/api/browser_action.json"><code>browser_action.json</code></a> in the Chromium code.</p>
<p>Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.</p>
</div>
<div class="hidden">
<pre class="notranslate">// 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>
|
