extension.getViews()

Returns an array of the Window objects for each of the pages running inside the current extension. This includes, for example:

  • the background page, if one is defined
  • any popup pages, if defined and loaded
  • any options pages, if defined and loaded
  • any browser tabs that host content packaged with the extension

In Firefox, if this method is called from a page that is part of a private browsing window, such as a sidebar in a private window or a popup opened from a private window, then its return value will not include the extension's background page.

Syntax

js

let windows = browser.extension.getViews(
  fetchProperties // optional object
)

Parameters

fetchProperties Optional

An object with the following properties:

type Optional

string. An extension.ViewType indicating the type of view to get. If omitted, this function returns all views.

windowId Optional

integer. The window to restrict the search to. If omitted, this function returns all views. In Firefox version 92 and earlier, sidebar views are not matched and, therefore, not returned.

Return value

array of object. Array of Window objects.

Browser compatibility

BCD tables only load in the browser

Examples

Get all windows belonging to this extension, and log their URLs:

js

const windows = browser.extension.getViews();

for (const extensionWindow of windows) {
  console.log(extensionWindow.location.href);
}

Get only windows in browser tabs hosting content packaged with the extension:

js

const windows = browser.extension.getViews({ type: "tab" });

Get only windows in popups:

js

const windows = browser.extension.getViews({ type: "popup" });

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