MDN self-hosted library · e01.org

WindowControlsOverlayGeometryChangeEvent

Window Controls Overlay API

Window Controls Overlay API

The WindowControlsOverlayGeometryChangeEvent interface of the Window Controls Overlay API is passed to geometrychange when the size or visibility of a desktop Progress Web App's title bar region changes.

Constructor

  • WindowControlsOverlayGeometryChangeEvent()
  • : Creates a WindowControlsOverlayGeometryChangeEvent event with the given parameters.

Instance properties

Also inherits properties from its parent Event.

  • WindowControlsOverlayGeometryChangeEvent.titlebarAreaRect
  • : A DOMRect representing the position and size of the title bar region.
  • WindowControlsOverlayGeometryChangeEvent.visible
  • : A Boolean that indicates whether the window controls overlay is visible or not.

Examples

The following example shows how to use a WindowControlsOverlayGeometryChangeEvent instance by adding an event handler on the Navigator.windowControlsOverlay property, to listen to geometry changes of a PWA's title bar region.

if ("windowControlsOverlay" in navigator) {
  navigator.windowControlsOverlay.addEventListener(
    "geometrychange",
    (event) => {
      if (event.visible) {
        const rect = event.titlebarAreaRect;
        // Do something with the coordinates of the title bar area.
      }
    },
  );
}

Specifications

Browser compatibility

See also