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

js
browser.tabs.onHighlighted.addListener(listener)
browser.tabs.onHighlighted.removeListener(listener)
browser.tabs.onHighlighted.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

listener

The function called when this event occurs. The function is passed this argument:

highlightInfo

object. ID(s) of the highlighted tabs, and ID of their window. See the highlightInfo section for more details.

Additional objects

highlightInfo

windowId

integer. ID of the window whose tabs changed.

tabIds

array of integer. IDs of the highlighted tabs in the window.

Examples

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

js
function handleHighlighted(highlightInfo) {
  console.log(`Highlighted tabs: ${highlightInfo.tabIds}`);
}

browser.tabs.onHighlighted.addListener(handleHighlighted);

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
onHighlighted

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.
Has more compatibility info.

Note: This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.json in the Chromium code.