tabs.highlight()

Highlights one or more tabs. Tabs are specified using a window ID and a range of tab indices.
 

This is an asynchronous function that returns a Promise.

Syntax

var highlighting = browser.tabs.highlight(
  highlightInfo         // object
)

Parameters

highlightInfo
object.
windowIdOptional
integer. ID of the window that contains the tabs.
populateOptional

boolean. Defaults to true. If set to false, the windows.Window object won't have a tabs property containing a list of tabs.Tab objects representing the tabs open in the window.

Note: Populating the window (the default behavior) can be an expensive operation if there are lots of tabs. For better performance it's recommended to manually set populate to false if you don't need tab details.

tabs
array of integer or integer. One or more tab indices to highlight. Previously highlighted tabs not included in tabs will stop being highlighted. The first tab in tabs will become active.

Return value

A Promise that will be fulfilled with a windows.Window object containing details about the window whose tabs were highlighted. If the window could not be found or some other error occurs, the promise will be rejected with an error message.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome Full support YesEdge No support NoFirefox Full support 63Opera No support NoFirefox Android No support No
highlightInfo.populateChrome No support NoEdge No support NoFirefox Full support 63Opera No support NoFirefox Android No support No

Legend

Full support  
Full support
No support  
No support

Acknowledgements

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

Contributors to this page: Loirooriol, chrisdavidmills, wbamberg, Makyen
Last updated by: Loirooriol,