tabs.onHighlighted

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

Note that before version 63, Firefox didn't have the concept of highlighting multiple tabs,  so this event was just an alias for tabs.onActivated.

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 support Yes No

63

45 — 621

541 No

1. Implemented as an alias for onActivated.

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.

Document Tags and Contributors

Contributors to this page: wbamberg, Makyen, rolfedh, matthewjwein
Last updated by: wbamberg,