chrome.app.window
- Description
Use the
chrome.app.window
API to create windows. Windows have an optional frame with title bar and size controls. They are not associated with any Chrome browser windows. See the Window State Sample for a demonstration of these options.
Summary
- Types
- Methods
app.window.canSetVisibleOnAllWorkspaces(): boolean
app.window.create(url: string, options: CreateWindowOptions, callback: function)
app.window.current(): AppWindow
app.window.get(id: string): AppWindow
app.window.getAll(): AppWindow[]
- Events
Types
AppWindow
Properties
- clearAttentionfunction
Clear attention to the window.
The clearAttention function looks like this:
clearAttention() => {...}
- closefunction
Close the window.
The close function looks like this:
close() => {...}
- contentWindowWindow
The JavaScript 'window' object for the created child.
- drawAttentionfunction
Draw attention to the window.
The drawAttention function looks like this:
drawAttention() => {...}
- focusfunction
Focus the window.
The focus function looks like this:
focus() => {...}
- fullscreenfunction
Fullscreens the window.
The user will be able to restore the window by pressing ESC. An application can prevent the fullscreen state to be left when ESC is pressed by requesting the
app.window.fullscreen.overrideEsc
permission and canceling the event by calling .preventDefault(), in the keydown and keyup handlers, like this:window.onkeydown = window.onkeyup = function(e) { if (e.keyCode == 27 /* ESC */) { e.preventDefault(); } };
Note
window.fullscreen()
will cause the entire window to become fullscreen and does not require a user gesture. The HTML5 fullscreen API can also be used to enter fullscreen mode (see Web APIs for more details).The fullscreen function looks like this:
fullscreen() => {...}
- getBoundsfunction
Deprecated. Use innerBounds or outerBounds.
Get the window's inner bounds as a
ContentBounds
object.The getBounds function looks like this:
getBounds(): ContentBounds => {...}
- returns
- hidefunction
Hide the window. Does nothing if the window is already hidden.
The hide function looks like this:
hide() => {...}
- idstring
The id the window was created with.
- innerBounds
The position, size and constraints of the window's content, which does not include window decorations. This property is new in Chrome 36.
- isAlwaysOnTopfunction
Is the window always on top?
The isAlwaysOnTop function looks like this:
isAlwaysOnTop(): boolean => {...}
- returnsboolean
- isFullscreenfunction
Is the window fullscreen? This will be true if the window has been created fullscreen or was made fullscreen via the
AppWindow
or HTML5 fullscreen APIs.The isFullscreen function looks like this:
isFullscreen(): boolean => {...}
- returnsboolean
- isMaximizedfunction
Is the window maximized?
The isMaximized function looks like this:
isMaximized(): boolean => {...}
- returnsboolean
- isMinimizedfunction
Is the window minimized?
The isMinimized function looks like this:
isMinimized(): boolean => {...}
- returnsboolean
- maximizefunction
Maximize the window.
The maximize function looks like this:
maximize() => {...}
- minimizefunction
Minimize the window.
The minimize function looks like this:
minimize() => {...}
- moveTofunction
Deprecated. Use outerBounds.
Move the window to the position (
left
,top
).The moveTo function looks like this:
moveTo(left: number, top: number) => {...}
- leftnumber
- topnumber
- outerBounds
The position, size and constraints of the window, which includes window decorations, such as the title bar and frame. This property is new in Chrome 36.
- resizeTofunction
Deprecated. Use outerBounds.
Resize the window to
width
xheight
pixels in size.The resizeTo function looks like this:
resizeTo(width: number, height: number) => {...}
- widthnumber
- heightnumber
- restorefunction
Restore the window, exiting a maximized, minimized, or fullscreen state.
The restore function looks like this:
restore() => {...}
- setAlwaysOnTopfunction
Set whether the window should stay above most other windows. Requires the
alwaysOnTopWindows
permission.The setAlwaysOnTop function looks like this:
setAlwaysOnTop(alwaysOnTop: boolean) => {...}
- alwaysOnTopboolean
- setBoundsfunction
Deprecated. Use innerBounds or outerBounds.
Set the window's inner bounds.
The setBounds function looks like this:
setBounds(bounds: ContentBounds) => {...}
- bounds
- setVisibleOnAllWorkspacesfunction
Set whether the window is visible on all workspaces. (Only for platforms that support this).
The setVisibleOnAllWorkspaces function looks like this:
setVisibleOnAllWorkspaces(alwaysVisible: boolean) => {...}
- alwaysVisibleboolean
- showfunction
Show the window. Does nothing if the window is already visible. Focus the window if
focused
is set to true or omitted.The show function looks like this:
show(focused: boolean) => {...}
- focusedboolean
Bounds
Properties
- heightnumber
This property can be used to read or write the current height of the content or window.
- leftnumber
This property can be used to read or write the current X coordinate of the content or window.
- maxHeightnumber optional
This property can be used to read or write the current maximum height of the content or window. A value of
null
indicates 'unspecified'. - maxWidthnumber optional
This property can be used to read or write the current maximum width of the content or window. A value of
null
indicates 'unspecified'. - minHeightnumber optional
This property can be used to read or write the current minimum height of the content or window. A value of
null
indicates 'unspecified'. - minWidthnumber optional
This property can be used to read or write the current minimum width of the content or window. A value of
null
indicates 'unspecified'. - setMaximumSizefunction
Set the maximum size constraints of the content or window. The maximum width or height can be set to
null
to remove the constraint. A value ofundefined
will leave a constraint unchanged.The setMaximumSize function looks like this:
setMaximumSize(maxWidth: number, maxHeight: number) => {...}
- maxWidthnumber
- maxHeightnumber
- setMinimumSizefunction
Set the minimum size constraints of the content or window. The minimum width or height can be set to
null
to remove the constraint. A value ofundefined
will leave a constraint unchanged.The setMinimumSize function looks like this:
setMinimumSize(minWidth: number, minHeight: number) => {...}
- minWidthnumber
- minHeightnumber
- setPositionfunction
Set the left and top position of the content or window.
The setPosition function looks like this:
setPosition(left: number, top: number) => {...}
- leftnumber
- topnumber
- setSizefunction
Set the width and height of the content or window.
The setSize function looks like this:
setSize(width: number, height: number) => {...}
- widthnumber
- heightnumber
- topnumber
This property can be used to read or write the current Y coordinate of the content or window.
- widthnumber
This property can be used to read or write the current width of the content or window.
BoundsSpecification
Properties
- heightnumber optional
The height of the content or window.
- leftnumber optional
The X coordinate of the content or window.
- maxHeightnumber optional
The maximum height of the content or window.
- maxWidthnumber optional
The maximum width of the content or window.
- minHeightnumber optional
The minimum height of the content or window.
- minWidthnumber optional
The minimum width of the content or window.
- topnumber optional
The Y coordinate of the content or window.
- widthnumber optional
The width of the content or window.
ContentBounds
Properties
- heightnumber optional
- leftnumber optional
- topnumber optional
- widthnumber optional
CreateWindowOptions
Properties
- alwaysOnTopboolean optional
If true, the window will stay above most other windows. If there are multiple windows of this kind, the currently focused window will be in the foreground. Requires the
alwaysOnTopWindows
permission. Defaults to false.Call
setAlwaysOnTop()
on the window to change this property after creation. - boundsContentBounds optional
Deprecated. Use innerBounds or outerBounds.
Size and position of the content in the window (excluding the titlebar). If an id is also specified and a window with a matching id has been shown before, the remembered bounds of the window will be used instead.
- focusedboolean optional
If true, the window will be focused when created. Defaults to true.
- framestring | FrameOptions optional
Frame type:
none
orchrome
(defaults tochrome
). Fornone
, the-webkit-app-region
CSS property can be used to apply draggability to the app's window.-webkit-app-region: drag
can be used to mark regions draggable.no-drag
can be used to disable this style on nested elements.Use of
FrameOptions
is new in M36. - hiddenboolean optional
If true, the window will be created in a hidden state. Call show() on the window to show it once it has been created. Defaults to false.
- iconstring optional
Since Chrome 54.
URL of the window icon. A window can have its own icon when showInShelf is set to true. The URL should be a global or an extension local URL.
- idstring optional
Id to identify the window. This will be used to remember the size and position of the window and restore that geometry when a window with the same id is later opened. If a window with a given id is created while another window with the same id already exists, the currently opened window will be focused instead of creating a new window.
- innerBoundsBoundsSpecification optional
Used to specify the initial position, initial size and constraints of the window's content (excluding window decorations). If an
id
is also specified and a window with a matchingid
has been shown before, the remembered bounds will be used instead.Note that the padding between the inner and outer bounds is determined by the OS. Therefore setting the same bounds property for both the
innerBounds
andouterBounds
will result in an error.This property is new in Chrome 36.
- maxHeightnumber optional
Deprecated. Use innerBounds or outerBounds.
Maximum height of the window.
- maxWidthnumber optional
Deprecated. Use innerBounds or outerBounds.
Maximum width of the window.
- minHeightnumber optional
Deprecated. Use innerBounds or outerBounds.
Minimum height of the window.
- minWidthnumber optional
Deprecated. Use innerBounds or outerBounds.
Minimum width of the window.
- outerBoundsBoundsSpecification optional
Used to specify the initial position, initial size and constraints of the window (including window decorations such as the title bar and frame). If an
id
is also specified and a window with a matchingid
has been shown before, the remembered bounds will be used instead.Note that the padding between the inner and outer bounds is determined by the OS. Therefore setting the same bounds property for both the
innerBounds
andouterBounds
will result in an error.This property is new in Chrome 36.
- resizableboolean optional
If true, the window will be resizable by the user. Defaults to true.
- showInShelfboolean optional
Since Chrome 54.
If true, the window will have its own shelf icon. Otherwise the window will be grouped in the shelf with other windows that are associated with the app. Defaults to false. If showInShelf is set to true you need to specify an id for the window.
- singletonboolean optional
Deprecated. Multiple windows with the same id is no longer supported.
By default if you specify an id for the window, the window will only be created if another window with the same id doesn't already exist. If a window with the same id already exists that window is activated instead. If you do want to create multiple windows with the same id, you can set this property to false.
- stateState optional
The initial state of the window, allowing it to be created already fullscreen, maximized, or minimized. Defaults to 'normal'.
- typeWindowType optional
Since Chrome 45.
Deprecated since Chrome 69. All app windows use the 'shell' window type
Type of window to create.
- visibleOnAllWorkspacesboolean optional
If true, and supported by the platform, the window will be visible on all workspaces.
FrameOptions
Properties
- activeColorstring optional
Allows the frame color of the window when active to be set. Frame coloring is only available if the frame type is
chrome
.Frame coloring is only available if the frame type is
chrome
.Frame coloring is new in Chrome 36.
- colorstring optional
Allows the frame color to be set. Frame coloring is only available if the frame type is
chrome
.Frame coloring is new in Chrome 36.
- inactiveColorstring optional
Allows the frame color of the window when inactive to be set differently to the active color. Frame coloring is only available if the frame type is
chrome
.inactiveColor
must be used in conjunction withcolor
.Frame coloring is new in Chrome 36.
- typestring optional
Frame type:
none
orchrome
(defaults tochrome
).For
none
, the-webkit-app-region
CSS property can be used to apply draggability to the app's window.-webkit-app-region: drag
can be used to mark regions draggable.no-drag
can be used to disable this style on nested elements.
State
State of a window: normal, fullscreen, maximized, minimized.
Enum
"normal"
, "fullscreen"
, "maximized"
, or "minimized"
WindowType
Since Chrome 45.
Specifies the type of window to create.
Enum
"shell"
, or "panel"
Methods
canSetVisibleOnAllWorkspaces
app.window.canSetVisibleOnAllWorkspaces(): boolean
Whether the current platform supports windows being visible on all workspaces.
Returns
- returnsboolean
create
app.window.create(url: string, options: CreateWindowOptions, callback: function)
The size and position of a window can be specified in a number of different ways. The most simple option is not specifying anything at all, in which case a default size and platform dependent position will be used.
To set the position, size and constraints of the window, use the innerBounds
or outerBounds
properties. Inner bounds do not include window decorations. Outer bounds include the window's title bar and frame. Note that the padding between the inner and outer bounds is determined by the OS. Therefore setting the same property for both inner and outer bounds is considered an error (for example, setting both innerBounds.left
and outerBounds.left
).
To automatically remember the positions of windows you can give them ids. If a window has an id, This id is used to remember the size and position of the window whenever it is moved or resized. This size and position is then used instead of the specified bounds on subsequent opening of a window with the same id. If you need to open a window with an id at a location other than the remembered default, you can create it hidden, move it to the desired location, then show it.
Parameters
- urlstring
- options
- callbackfunction
Called in the creating window (parent) before the load event is called in the created window (child). The parent can set fields or functions on the child usable from onload. E.g. background.js:
function(createdWindow) { createdWindow.contentWindow.foo = function () { }; };
window.js:
window.onload = function () { foo(); }
The callback parameter should be a function that looks like this:
(createdWindow: AppWindow) => {...}
- createdWindow
current
app.window.current(): AppWindow
Returns an AppWindow
object for the current script context (ie JavaScript 'window' object). This can also be called on a handle to a script context for another page, for example: otherWindow.chrome.app.window.current().
Returns
- returns
get
app.window.get(id: string): AppWindow
Gets an AppWindow
with the given id. If no window with the given id exists null is returned. This method is new in Chrome 33.
Parameters
- idstring
Returns
- returns
getAll
app.window.getAll(): AppWindow[]
Gets an array of all currently created app windows. This method is new in Chrome 33.
Returns
- returns
Events
onBoundsChanged
app.window.onBoundsChanged.addListener(listener: function)
Fired when the window is resized.
Event
- listenerfunction
The listener parameter should be a function that looks like this:
() => {...}
onClosed
app.window.onClosed.addListener(listener: function)
Fired when the window is closed. Note, this should be listened to from a window other than the window being closed, for example from the background page. This is because the window being closed will be in the process of being torn down when the event is fired, which means not all APIs in the window's script context will be functional.
Event
- listenerfunction
The listener parameter should be a function that looks like this:
() => {...}
onFullscreened
app.window.onFullscreened.addListener(listener: function)
Fired when the window is fullscreened (either via the AppWindow
or HTML5 APIs).
Event
- listenerfunction
The listener parameter should be a function that looks like this:
() => {...}
onMaximized
app.window.onMaximized.addListener(listener: function)
Fired when the window is maximized.
Event
- listenerfunction
The listener parameter should be a function that looks like this:
() => {...}
onMinimized
app.window.onMinimized.addListener(listener: function)
Fired when the window is minimized.
Event
- listenerfunction
The listener parameter should be a function that looks like this:
() => {...}
onRestored
app.window.onRestored.addListener(listener: function)
Fired when the window is restored from being minimized or maximized.
Event
- listenerfunction
The listener parameter should be a function that looks like this:
() => {...}