title | slug | page-type | browser-compat |
---|---|---|---|
tabs.onHighlighted |
Mozilla/Add-ons/WebExtensions/API/tabs/onHighlighted |
webextension-api-event |
webextensions.api.tabs.onHighlighted |
{{AddonSidebar}}
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 {{WebExtAPIRef("tabs.onActivated")}}.
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.
- : Stop listening to this event. The
hasListener(listener)
- : Check whether
listener
is registered for this event. Returnstrue
if it is listening,false
otherwise.
- : Check whether
-
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.
- :
-
windowId
- :
integer
. ID of the window whose tabs changed.
- :
tabIds
- :
array
ofinteger
. IDs of the highlighted tabs in the window.
- :
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);
{{WebExtExamples}}
{{Compat}}
Note
This API is based on Chromium's chrome.tabs
API. This documentation is derived from tabs.json
in the Chromium code.