browserAction

מוסיף כפתור לסרגל הכלים של הדפדפן.

 פעולת דפדפן הינה כפתור בסרגל הכלים של הדפדפן.

ניתן לקשר חלון קופץ עם הכפתור. החלון הקופץ מצויין באמצעות HTML, CSS וג'אווה-סקריפט , בדומה לדף רשת רגיל. לקוד ג'אווה-סקריפט המורץ בחלון הקופץ גישה לכל ממשקי פיתוח היישומים של הרחבת הרשת כמו תסריטי הרקע שלך, אך ההקשר הגלובלי שלו הוא החלון הקופץ, ולא הדף הנוכחי המוצג על ידי הדפדפן. כדי להספיע לע הדפים מהרשת יש לתקשר איתם דרך  messages.

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.

You can define most of a browser action's properties declaratively using the browser_action key in the manifest.json.

With the browserAction API, you can:

  • use browserAction.onClicked to listen for clicks on the icon.
  • 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.

Types

browserAction.ColorArray
An array of four integers in the range 0-255 defining an RGBA color.
browserAction.ImageDataType
Pixel data for an image. Must be an ImageData object (for example, from a <canvas> element).

Functions

browserAction.setTitle()
Sets the browser action's title. This will be displayed in a tooltip.
browserAction.getTitle()
Gets the browser action's title.
browserAction.setIcon()
Sets the browser action's icon.
browserAction.setPopup()
Sets the HTML document to be opened as a popup when the user clicks on the browser action's icon.
browserAction.getPopup()
Gets the HTML document set as the browser action's popup.
browserAction.openPopup()
Open the browser action's popup.
browserAction.setBadgeText()
Sets the browser action's badge text. The badge is displayed on top of the icon.
browserAction.getBadgeText()
Gets the browser action's badge text.
browserAction.setBadgeBackgroundColor()
Sets the badge's background color.
browserAction.getBadgeBackgroundColor()
Gets the badge's background color.
browserAction.setBadgeTextColor()
Sets the badge's text color.
browserAction.getBadgeTextColor()
Gets the badge's text color.
browserAction.enable()
Enables the browser action for a tab. By default, browser actions are enabled for all tabs.
browserAction.disable()
Disables the browser action for a tab, meaning that it cannot be clicked when that tab is active.
browserAction.isEnabled()
Checks whether the browser action is enabled or not.

Events

browserAction.onClicked
Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.

Browser compatibility

BCD tables only load in the browser

Example extensions

Acknowledgements

This API is based on Chromium's chrome.browserAction API. This documentation is derived from browser_action.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.