action.onClicked
Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.
Note: This API is available in Manifest V3 or higher.
To define a right-click action, use the contextMenus
API with the "browser_action" context type.
Syntax
browser.action.onClicked.addListener(listener)
browser.action.onClicked.removeListener(listener)
browser.action.onClicked.hasListener(listener)
Events have three functions:
-
addListener(listener)
-
Adds a listener to this event.
-
removeListener(listener)
-
Stop listening to this event. The listener
argument is the listener to remove.
-
hasListener(listener)
-
Check whether listener
is registered for this event. Returns true
if it is listening, false
otherwise.
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 of Shift
, Alt
, Command
, Ctrl
, or MacCtrl
.
-
button
-
An integer
. Indicates the button used to click the page action icon: 0
for a left-click or a click not associated with a mouse, such as one from the keyboard and 1
for 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.
Examples
When the user clicks the icon, disable it for the active tab, and log the tab's URL:
browser.action.onClicked.addListener((tab) => {
browser.action.disable(tab.id);
console.log(tab.url);
});
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 |
onClicked |
88 |
88 |
109 |
? |
74 |
No |
? |
? |
109 |
? |
No |
? |