browserAction

Diese Übersetzung ist unvollständig. Bitte helfen Sie uns, diesen Artikel aus dem Englischen zu übersetzen

Adds a button to the browser's toolbar.

A browser action is a button in the browser's toolbar.

You can associate a popup with the button. The popup is specified using HTML, CSS and JavaScript, just like a normal web page. JavaScript running in the popup gets access to all the same WebExtension APIs as your background scripts, but its global context is the popup, not the current page displayed in the browser. To affect web pages you need to communicate with them via 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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaSafariFirefox für Android
ColorArrayChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 79
ImageDataTypeChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 79
disableChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 79
enableChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 79
getBadgeBackgroundColorChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45Opera Vollständige Unterstützung JaSafari Teilweise Unterstützung 14
Hinweise
Teilweise Unterstützung 14
Hinweise
Hinweise Always returns a red ColorArray.
Firefox Android Vollständige Unterstützung 79
getBadgeTextChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 79
getBadgeTextColorChrome Keine Unterstützung NeinEdge Keine Unterstützung NeinFirefox Vollständige Unterstützung 63Opera Keine Unterstützung NeinSafari Keine Unterstützung NeinFirefox Android Vollständige Unterstützung 79
getPopupChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 79Firefox Vollständige Unterstützung 45Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 57
getTitleChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 15Firefox Vollständige Unterstützung 45Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 55
isEnabledChrome Keine Unterstützung NeinEdge Keine Unterstützung NeinFirefox Vollständige Unterstützung 59Opera Keine Unterstützung NeinSafari Keine Unterstützung NeinFirefox Android Vollständige Unterstützung 79
onClickedChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 55
openPopupChrome Vollständige Unterstützung 67
Deaktiviert
Vollständige Unterstützung 67
Deaktiviert
Deaktiviert From version 67: this feature is behind the #extension-apis preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.
Edge Vollständige Unterstützung 79
Deaktiviert
Vollständige Unterstützung 79
Deaktiviert
Deaktiviert From version 79: this feature is behind the #extension-apis preference (needs to be set to Enabled).
Firefox Vollständige Unterstützung 57Opera Keine Unterstützung NeinSafari Keine Unterstützung NeinFirefox Android Vollständige Unterstützung 79
setBadgeBackgroundColorChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45
Vollständige Unterstützung 45
Keine Unterstützung 45 — 58
Hinweise
Hinweise Tab-specific badge background color is not cleared when a new page is loaded.
Opera Vollständige Unterstützung JaSafari Teilweise Unterstützung 14
Hinweise
Teilweise Unterstützung 14
Hinweise
Hinweise The API exists, but has no effect.
Firefox Android Vollständige Unterstützung 79
setBadgeTextChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45
Vollständige Unterstützung 45
Keine Unterstützung 45 — 58
Hinweise
Hinweise Tab-specific badge text is not cleared when a new page is loaded.
Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 79
setBadgeTextColorChrome Keine Unterstützung NeinEdge Keine Unterstützung NeinFirefox Vollständige Unterstützung 63Opera Keine Unterstützung NeinSafari Keine Unterstützung NeinFirefox Android Vollständige Unterstützung 79
setIconChrome Vollständige Unterstützung Ja
Hinweise
Vollständige Unterstützung Ja
Hinweise
Hinweise Before Chrome 23, `path` couldn't specify multiple icon files, but had to be a string specifying a single icon path.
Edge Vollständige Unterstützung 14
Hinweise
Vollständige Unterstützung 14
Hinweise
Hinweise This call is not persisted.
Hinweise The imageData parameter is not accepted.
Hinweise The path parameter is required.
Firefox Vollständige Unterstützung 45
Vollständige Unterstützung 45
Keine Unterstützung 45 — 58
Hinweise
Hinweise Tab-specific icons are not cleared when a new page is loaded.
Opera Vollständige Unterstützung 15Safari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 79
setPopupChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45
Vollständige Unterstützung 45
Keine Unterstützung 45 — 58
Hinweise
Hinweise Tab-specific popups are not cleared when a new page is loaded.
Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 57
Vollständige Unterstützung 57
Keine Unterstützung 57 — 58
Hinweise
Hinweise Tab-specific popups are not cleared when a new page is loaded.
setTitleChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 15Firefox Vollständige Unterstützung 45
Vollständige Unterstützung 45
Keine Unterstützung 45 — 58
Hinweise
Hinweise Tab-specific titles are not cleared when a new page is loaded.
Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 55
Vollständige Unterstützung 55
Keine Unterstützung 55 — 58
Hinweise
Hinweise Tab-specific titles are not cleared when a new page is loaded.

Legende

Vollständige Unterstützung  
Vollständige Unterstützung
Teilweise Unterstützung  
Teilweise Unterstützung
Keine Unterstützung  
Keine Unterstützung
Siehe Implementierungshinweise.
Siehe Implementierungshinweise.
Benutzer muss dieses Feature explizit aktivieren.
Benutzer muss dieses Feature explizit aktivieren.

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.