Firefox Tomorrow

web api interface

WindowControlsOverlay

View on MDN ↗

Secure contextLimited availability

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 windowControlsOverlay.

Instance properties

  • visible Read only Experimental
    • : A Boolean that indicates whether the window controls overlay is visible or not.

Instance methods

Events

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

  • geometrychange Experimental
    • : Fired when the geometry of the title bar area changes.

Examples

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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.