MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/MDN-dev-survey

Add-ons

tabs.onHighlighted

Fired when the set of highlighted tabs in a window changes.

Firefox doesn't have the concept of highlighting multiple tabs, and so in Firefox highlighting is just an alias for tab activation. So this event will fire only when the active tab in a window changes, and the tabIds property of highlightInfo will always be an array of length one, with the tabId referring to the active tab.

Syntax

browser.tabs.onHighlighted.addListener(listener)
browser.tabs.onHighlighted.removeListener(listener)
browser.tabs.onHighlighted.hasListener(listener)

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:

highlightInfo
object. ID(s) of the highlighted tabs, and ID of their window.

Additional objects

highlightInfo

windowId
integer. ID of the window whose tabs changed.
tabIds
array of integer. IDs of the highlighted tabs in the window.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportYesNo4554No

Examples

Listen for highlighting events, and log the IDs of highlighted tabs:

function handleHighlighted(highlightInfo) {
  console.log("Highlighted tabs: " + highlightInfo.tabIds);
}

browser.tabs.onHighlighted.addListener(handleHighlighted);

Acknowledgements

This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.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: wbamberg, Makyen, rolfedh, matthewjwein
 Last updated by: wbamberg,