Interact with browser windows. You can use this API to get information about open windows and to open, modify, and close windows. You can also listen for window open, close, and activate events.
Types
windows.WindowType
- The type of browser window this is.
windows.WindowState
- The state of this browser window.
windows.Window
- Contains information about a browser window.
windows.CreateType
- Specifies the type of browser window to create.
Properties
windows.WINDOW_ID_NONE
- The
windowId
value that represents the absence of a browser window. windows.WINDOW_ID_CURRENT
- The
windowId
value that represents the current window.
Functions
windows.get()
- Gets details about a window, given its ID.
windows.getCurrent()
- Gets the current window.
windows.getLastFocused()
- Gets the window that was most recently focused — typically the window 'on top'.
windows.getAll()
- Gets all windows.
windows.create()
-
Creates a new window.
windows.update()
- Updates the properties of a window. Use this to move, resize, and (un)focus a window, etc.
windows.remove()
- Closes a window, and all its tabs.
Events
windows.onCreated
- Fired when a window is created.
windows.onRemoved
- Fired when a window is closed.
windows.onFocusChanged
- Fired when the currently focused window changes.
Browser compatibility
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
CreateType | Yes * | Yes * | 45 | No | Yes * |
WINDOW_ID_CURRENT | 18 | Yes | 45 | No | 15 |
WINDOW_ID_NONE | Yes | Yes | 45 | No | Yes |
Window | Yes * | Yes * | 45 * | No | Yes * |
WindowState | Yes | Yes * | 45 * | No | Yes |
WindowType | Yes | Yes * | 45 | No | Yes |
create | Yes * | Yes * | 45 * | No | Yes * |
get | Yes * | Yes | 45 | No | Yes * |
getAll | Yes * | Yes * | 45 | No | Yes * |
getCurrent | Yes * | Yes | 45 | No | Yes * |
getLastFocused | Yes * | Yes | 45 | No | Yes * |
onCreated | Yes | Yes | 45 | No | Yes |
onFocusChanged | Yes | Yes | 45 | No | Yes |
onRemoved | Yes | No | 45 | No | Yes |
remove | Yes | No | 45 | No | Yes |
update | Yes | Yes * | 45 | No | Yes |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Edge incompatibilities
Promises are not supported in Edge. Use callbacks instead.
Chrome incompatibilities
windows
- In Firefox
onFocusChanged
will trigger multiple times for a given focus change.
Example extensions
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.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.