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 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.

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 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.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaSafariFirefox for Android
onClickedChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesSafari Full support 14Firefox Android Full support 55
OnClickDataChrome No support NoEdge No support NoFirefox Full support 72Opera No support NoSafari No support NoFirefox Android No support No
tabChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesSafari Full support 14Firefox Android Full support 55

Legend

Full support  
Full support
No support  
No support

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
  console.log(tab.url);
});

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.