windows.getCurrent()

Syntax

let gettingCurrent = browser.windows.getCurrent(
  getInfo               // optional object
)

Parameters

getInfo Optional

object.

populate Optional

boolean. If true, the windows.Window object will have a tabs property that contains a list of tabs.Tab objects representing the tabs in the window. The Tab objects only contain the url, title and favIconUrl properties 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 returned will be filtered based on its 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 a windows.Window object containing the details of the window. If any error occurs, the promise will be rejected with an error message.

Examples

When the user clicks a browser action's icon, this example gets the current window and logs the URLs of the tabs it contains. Note that you'll need the "tabs" permission or matching host permissions to access tab URLs.

function logTabs(windowInfo) {
  for (const tabInfo of windowInfo.tabs) {
    console.log(tabInfo.url);
  }
}

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

browser.browserAction.onClicked.addListener((tab) => {
  browser.windows.getCurrent({ populate: true }).then(logTabs, onError);
});

Example extensions

• annotate-page
• theme-integrated-sidebar
• window-manipulator

Browser compatibility