windows.remove()

Closes a window and all the tabs inside it, given the window's ID.

This is an asynchronous function that returns a Promise.

Syntax

var removing = browser.windows.remove(
  windowId        // integer
)

Parameters

windowId
integer. ID of the window to close.

Return value

A Promise that will be fulfilled with no arguments when the window has been closed. If any error occurs, the promise will be rejected with an error message.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 45.0 No 33

Examples

When the user clicks a browser action's icon, close the window in which the icon was clicked:

function onRemoved() {
  console.log(`Removed window`);
}

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

browser.browserAction.onClicked.addListener((tab) => {

  var removing = browser.windows.remove(tab.windowId);
  removing.then(onRemoved, onError);

});

Acknowledgements

This API is based on Chromium's chrome.windows API. This documentation is derived from windows.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.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, chrisdavidmills
 Last updated by: wbamberg,