Skip to content

Latest commit

 

History

History
99 lines (75 loc) · 3.57 KB

index.md

File metadata and controls

99 lines (75 loc) · 3.57 KB
Raw
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")}}.

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 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:

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

browser.tabs.onHighlighted.addListener(handleHighlighted);

{{WebExtExamples}}

Browser compatibility

{{Compat}}

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