browserAction.onClicked
Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.
To define a right-click action, use the contextMenus API with the "browser_action" context type.
Syntax
browser.browserAction.onClicked.addListener(listener) browser.browserAction.onClicked.removeListener(listener) browser.browserAction.onClicked.hasListener(listener)
Events have three functions:
addListener(listener)-
Adds a listener to this event.
removeListener(listener)-
Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)-
Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
callback-
Function that will be called when this event occurs. The function will be passed the following arguments:
tab-
tabs.Tab. The tab that was active when the icon was clicked. OnClickData-
An object containing information about the click.
modifiers-
An
array. The keyboard modifiers active at the time of the click, being one or more ofShift,Alt,Command,Ctrl, orMacCtrl. -
An
integer. Indicates the button used to click the page action icon:0for a left-click or a click not associated with a mouse, such as one from the keyboard and1for a middle button or wheel click. Note that the right-click is not supported because Firefox consumes that click to display the context menu before this event is triggered.
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
OnClickData |
No | No | 72 | ? | No | No | ? | ? | 79 | ? | No | ? |
onClicked |
Yes | 14 | 45 | ? | Yes | 14 | ? | ? | 55 | ? | 15 | ? |
tab |
Yes | 14 | 45 | ? | Yes | 14 | ? | ? | 55 | ? | 15 | ? |
Examples
When the user clicks the icon, disable it for the active tab, and log the tab's URL:
browser.browserAction.onClicked.addListener((tab) => { // disable the active tab browser.browserAction.disable(tab.id); // requires the "tabs" or "activeTab" permission, or host permissions for the URL console.log(tab.url); });
Example extensions
- bookmark-it
- favourite-colour
- find-across-tabs
- forget-it
- google-userinfo
- native-messaging
- open-my-page-button
- permissions
- runtime-examples
- store-collected-images
Note:
This API is based on Chromium's chrome.browserAction API. This documentation is derived from browser_action.json in the Chromium code.
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browserAction/onClicked