windows.getAll()

Gets information about all open windows, passing them into a callback.

This is an asynchronous function that returns a Promise.

Syntax

js

let gettingAll = browser.windows.getAll(
  getInfo                // optional object
)

Parameters

getInfo Optional

object. This controls what windows.Window objects are retrieved.

populate Optional

boolean. Defaults to false. If set to true, each windows.Window object will have a tabs property that contains a list of tabs.Tab objects representing the tabs in that window. The Tab objects will contain the url, title and favIconUrl properties only if the extension's manifest file includes the "tabs" permission or host permissions that match the tab's URL.

windowTypes Optional

An array of windows.WindowType objects. If set, the windows.Window objects returned will be filtered based on their type. If unset the default filter is set to ['normal', 'panel', 'popup'], with 'panel' window types limited to the extension's own windows.

Return value

A Promise that will be fulfilled with an array of windows.Window objects, representing all windows that match the given criteria. If any error occurs, the promise will be rejected with an error message.

Browser compatibility

BCD tables only load in the browser

Examples

Log the URLs for the tabs across all "normal" browser windows. Note that you'll need the "tabs" permission or matching host permissions to access tab URLs.

js

function logTabsForWindows(windowInfoArray) {
  for (const windowInfo of windowInfoArray) {
    console.log(`Window: ${windowInfo.id}`);
    console.log(windowInfo.tabs.map((tab) => tab.url));
  }
}

function onError(error) {
  console.error(`Error: ${error}`);
}

browser.browserAction.onClicked.addListener((tab) => {
  browser.windows
    .getAll({
      populate: true,
      windowTypes: ["normal"],
    })
    .then(logTabsForWindows, onError);
});

Example extensions

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