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
)
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 |
45If 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 |
? |
? |
48If 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 |
45Since Firefox 93, sidebar views are now matched.
|
? |
Yes |
14Filtering by windowId won't work when a tab is moved from one window to another.
|
? |
? |
48The property is recognized, but the filter has no effect.
|
? |
15Filtering 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:
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:
const windows = browser.extension.getViews({ type: "tab" });
Get only windows in popups:
const windows = browser.extension.getViews({ type: "popup" });