tabs.highlight()
Highlights (selects) 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
js
let highlighting = browser.tabs.highlight(
highlightInfo // object
)
Parameters
highlightInfo
-
object
.windowId
Optional-
integer
. ID of the window that contains the tabs. populate
Optional-
boolean
. Defaults totrue
. If set tofalse
, thewindows.Window
object won't have atabs
property containing a list oftabs.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
tofalse
if you don't need tab details. tabs
-
array
of integer values specifying one or more tab indices to highlight. Previously highlighted tabs not included intabs
will stop being highlighted. The first tab intabs
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
BCD tables only load in the browser
Note: This API is based on Chromium's chrome.tabs
API. This documentation is derived from tabs.json
in the Chromium code.