WindowControlsOverlayGeometryChangeEvent
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.
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
WindowControlsOverlayGeometryChangeEventevent with the given parameters.
Instance properties
Also inherits properties from its parent Event.
WindowControlsOverlayGeometryChangeEvent.titlebarAreaRectRead only-
A
DOMRectrepresenting the position and size of the title bar region. WindowControlsOverlayGeometryChangeEvent.visibleRead only-
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
| Specification |
|---|
| Window Controls Overlay # windowcontrolsoverlay-interface |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
WindowControlsOverlayGeometryChangeEvent
|
|
|
|
|
|
|
|
|
|
|
|
|
WindowControlsOverlayGeometryChangeEvent() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
titlebarAreaRect
|
|
|
|
|
|
|
|
|
|
|
|
|
visible
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.