windows.update()

Updates the properties of a window. Use this to move, resize, and (un)focus a window, etc.

This is an asynchronous function that returns a Promise.

Syntax

var updating = browser.windows.update(
  windowId,              // integer
  updateInfo             // object
)

Parameters

windowId
integer. ID of the window to update.
updateInfo
object. Object containing the properties to update.
leftOptional
integer. The offset from the left edge of the screen to move the window to in pixels. This value is ignored for panels.
topOptional
integer. The offset from the top edge of the screen to move the window to in pixels. This value is ignored for panels.
widthOptional
integer. The width to resize the window to in pixels. This value is ignored for panels.
heightOptional
integer. The height to resize the window to in pixels. This value is ignored for panels.
focusedOptional
boolean. If true, brings the window to the front. If false, brings the next window in the z-order to the front.
drawAttentionOptional
boolean. If true, causes the window to be displayed in a manner that draws the user's attention to the window, without changing the focused window. The effect lasts until the user changes focus to the window. This option has no effect if the window already has focus. Set to false to cancel a previous drawAttention request.
stateOptional
windows.WindowState. The new state of the window. The minimized, maximized and fullscreen states cannot be combined with left, top, width or height.

Return value

A Promise that will be fulfilled with a windows.Window object containing the details of the updated window. 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 Yes 45.0 No 33

Examples

When the user clicks a browser action's icon, move the window to the top left corner:

function onUpdated(windowInfo) {
  console.log(`Updated window: ${windowInfo.id}`);
}

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

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

  var updating = browser.windows.update(tab.windowId, {
    left: 0,
    top: 0
  });
  updating.then(onUpdated, 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,