Window: getScreenDetails() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The getScreenDetails()
method of the
Window
interface returns a Promise
that fulfills with a ScreenDetails
object instance representing the details of all the screens available to the user's device.
Syntax
getScreenDetails()
Parameters
None.
Return value
A Promise
that fulfills with a ScreenDetails
object instance.
Exceptions
NotAllowedError
DOMException
-
Thrown if a
window-management
Permissions-Policy is set that blocks use of the Window Management API, or if the user has explicitly denied the browser's permission request to use the API.
Examples
When getScreenDetails()
is invoked, the user will be asked for permission to manage windows on all their displays (the status of this permission can be checked using Permissions.query()
to query window-management
). Provided they grant permission, the resulting ScreenDetails
object contains details of all the screens available to the user's system.
The below example opens a full-size window on each available display.
const screenDetails = await window.getScreenDetails();
// Open a full-size window on each screen available to the device
for (const screen of screenDetails.screens) {
window.open(
"https://example.com",
"_blank",
`left=${screen.availLeft},
top=${screen.availTop},
width=${screen.availWidth},
height=${screen.availHeight}`,
);
}
Note: See Multi-window learning environment for a full example (see the source code also).
Specifications
Specification |
---|
Window Management # api-window-getScreenDetails-method |
Browser compatibility
BCD tables only load in the browser