This is an asynchronous function that returns a Promise.
Syntax
var highlighting = browser.tabs.highlight( highlightInfo // object )
Parameters
highlightInfoobject.-
windowIdOptionalinteger. ID of the window that contains the tabs.populateOptional-
boolean. Defaults totrue. If set tofalse, thewindows.Windowobject won't have atabsproperty containing a list oftabs.Tabobjects 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
populatetofalseif you don't need tab details. tabsarrayof integer values specifying one or more tab indices to highlight. Previously highlighted tabs not included intabswill stop being highlighted. The first tab intabswill 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
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.
| Desktop | Mobile | ||||
|---|---|---|---|---|---|
| Basic support | Chrome Full support Yes | Edge No support No | Firefox Full support 63 | Opera No support No | Firefox Android No support No |
highlightInfo.populate | Chrome No support No | Edge No support No | Firefox Full support 63 | Opera No support No | Firefox Android No support No |
Legend
- Full support
- Full support
- No support
- No support
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.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.