ScreenDetails: screenschange event

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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 screenschange event of the ScreenDetails interface is fired when the set of screens available to the system has changed: that is, a new screen has become available or an existing screen has become unavailable. This will be reflected in a change in the screens array.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("screenschange", (event) => {});

onscreenschange = (event) => {};

Event type

A generic Event.

Examples

You could use the screenschange event to detect when the available screens have changed, report the change, close all windows, and then reopen them all to suit the new configuration:

js
const screenDetails = await window.getScreenDetails();

// Return the number of screens
let noOfScreens = screenDetails.screens.length;

screenDetails.addEventListener("screenschange", () => {
  // If the new number of screens is different to the old number of screens, report the difference
  if (screenDetails.screens.length !== noOfScreens) {
    console.log(
      `The screen count changed from ${noOfScreens} to ${screenDetails.screens.length}`,
    );

    // Update noOfScreens value
    noOfScreens = screenDetails.screens.length;
  }

  // Open, close, or rearrange windows as needed, to fit the new screen configuration
  updateWindows();
});

Specifications

Specification
Window Management
# eventdef-screendetails-screenschange
Window Management
# ref-for-dom-screendetails-onscreenschange

Browser compatibility

BCD tables only load in the browser

See also