pageAction.onClicked
Fired when a page action icon is clicked. This event will not fire if the page action has a popup.
To define a right-click action, use the contextMenus
API with the "page_action" context type.
Syntax
browser.pageAction.onClicked.addListener(listener)
browser.pageAction.onClicked.removeListener(listener)
browser.pageAction.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)
-
Checks whether a
listener
is registered for this event. Returnstrue
if it is listening,false
otherwise.
addListener syntax
Parameters
listener
-
The function called when this event occurs. The function is passed these arguments:
tab
-
A
tabs.Tab
object representing the tab whose page action 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:0
for a left-click or a click not associated with a mouse, such as one from the keyboard and1
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.
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | ||||||
---|---|---|---|---|---|---|---|
onClicked | |||||||
OnClickData | |||||||
tab |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
Examples
When the user clicks the page action, hide it, and navigate the active tab to "https://giphy.com/explore/cat":
let catGifs = "https://giphy.com/explore/cat";
browser.pageAction.onClicked.addListener((tab) => {
browser.pageAction.hide(tab.id);
browser.tabs.update({ url: catGifs });
});
browser.pageAction.onClicked.addListener(() => {});
Example extensions
Note:
This API is based on Chromium's chrome.pageAction
API. This documentation is derived from page_action.json
in the Chromium code.