tabs.onHighlighted
Fired when the set of highlighted tabs in a window changes.
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(listener)- : Adds a listener to this event.
removeListener(listener)- : Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)- : Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
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- :
arrayofinteger. IDs of the highlighted tabs in the window.
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);
Browser compatibility
[!NOTE] This API is based on Chromium's
chrome.tabsAPI. This documentation is derived fromtabs.jsonin the Chromium code.