tabs.highlight()
This is an asynchronous function that returns a Promise
.
Syntax
var highlighting = browser.tabs.highlight(
highlightInfo // object
)
Parameters
highlightInfo
object
.-
windowId
Optionalinteger
. 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
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
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.