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 thecontextMenus 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. Thelistener argument is the listener to remove.
hasListener(listener): Check whetherlistener 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

tabs.Tab. The tab that was active when the icon was clicked.

OnClickData

An object containing information about the click.

modifiers: Anarray. The keyboard modifiers active at the time of the click, being one or more ofShift,Alt,Command,Ctrl, orMacCtrl.
button: Aninteger. 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.

Examples

When the user clicks the browser action icon this code turns it off for the active tab and logs the tab's URL:

browser.browserAction.onClicked.addListener((tab) => {  // disable the browser action for the tab  browser.browserAction.disable(tab.id);  // requires the "tabs" or "activeTab" permission, or host permissions for the URL  console.log(tab.url);});