windows.getCurrent()

Gets the current browser window, passing its details into a callback.

The "current" window is not necessarily the same as the currently focused window. If this function is called from a background script, then it returns the currently focused window. But if it is called from a script whose document is associated with a particular browser window, then it returns that browser window. For example, if the browser is displaying a sidebar, then every browser window has its own instance of the sidebar document. If a script running in the sidebar document callsgetCurrent(), then it will return that sidebar document's window.

This is an asynchronous function that returns aPromise.

Syntax

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

Parameters

getInfoOptional

object.

populateOptional: boolean. If true, thewindows.Window object will have atabs property that contains a list oftabs.Tab objects representing the tabs in the window. TheTab objects only contain theurl,title andfavIconUrl properties if the extension's manifest file includes the"tabs" permission orhost permissions that match the tab's URL.
windowTypesDeprecatedOptional: Anarray ofwindows.WindowType objects. If set, thewindows.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.

Note:If supplied, thewindowTypes component ofgetInfo is ignored. The use ofwindowTypes has been deprecated as of Firefox 62.

Return value

APromise that will be fulfilled with awindows.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 matchinghost 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);});