This is an asynchronous function that returns a Promise
.
var highlighting = browser.tabs.highlight( highlightInfo // object )
highlightInfo
object
.windowId
Optional
integer
. ID of the window that contains the tabs.populate
Optional
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 values specifying 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.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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
highlight |
Yes |
79 |
63 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
Note: 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.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/highlight