WindowControlsOverlay

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 WindowControlsOverlay interface of the Window Controls Overlay API exposes information about the geometry of the title bar area in desktop Progressive Web Apps, and an event to know whenever it changes. This interface is accessible from Navigator.windowControlsOverlay.

Properties

WindowControlsOverlay.visible Read only

A Boolean that indicates whether the window controls overlay is visible or not.

Methods

WindowControlsOverlay.getTitlebarAreaRect()

Returns the size and position of the title bar.

Events

Listen to these events using EventTarget.addEventListener() or by assigning an event listener to the relevant oneventname property of this interface.

geometrychange

Fired when the geometry of the title bar area changes.

Examples

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

Specifications

No specification found

No specification data found for api.WindowControlsOverlay.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

Browser compatibility

No compatibility data found for api.WindowControlsOverlay.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.