Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

browserAction.onClicked

Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.

Syntax

chrome.browserAction.onClicked.addListener(function(
  tab      // tabs.Tab object
) {...})
chrome.browserAction.onClicked.removeListener(listener)
chrome.browserAction.onClicked.hasListener(listener)

This API is also available as browser.browserAction.onClicked.*.

Events have three functions:

addListener(callback)
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.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 No 33

Examples

When the user clicks the icon, disable it for the active tab, and log the tab's URL:

chrome.browserAction.onClicked.addListener((tab) => {
  // disable the active tab
  chrome.browserAction.disable(tab.id);
  // requires the "tabs" or "activeTab" permission
  console.log(tab.url);
});

Example add-ons

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.

Document Tags and Contributors

 Contributors to this page: Makyen, wbamberg, kaze
 Last updated by: Makyen,