web_extensions / latest / api / extension / getviews.html /

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

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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getViews
Yes
14
45
If this 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.
?
Yes
14
?
?
48
If this 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.
?
15
?
windowId
Yes
14
93
Sidebar views are now matched.
45
?
Yes
14
Filtering by windowId won't work when a tab is moved from one window to another.
?
?
48
The property is recognized, but the filter has no effect.
?
15
Filtering by windowId won't work when a tab is moved from one window to another.
?

Examples

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

let windows = browser.extension.getViews();

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

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

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

Get only windows in popups:

let 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.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

© 2005–2022 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/extension/getViews

Name Web Extensions
Version
Badge
Last Updated 2022-04-28T06:26:19Z