MDN self-hosted library · e01.org

VirtualKeyboard: geometrychange event

VirtualKeyboard API

VirtualKeyboard API

The geometrychange event of the VirtualKeyboard interface fires when the on-screen virtual keyboard is toggled between shown and hidden states.

The geometrychange event is useful to detect when the virtual keyboard appears and disappears, so you can adjust the layout as appropriate. This is necessary when using the Virtual Keyboard API to disable the browser's default automatic resizing of the viewport when the virtual keyboard is shown and hidden.

Syntax

Use the event name in addEventListener():

addEventListener("geometrychange", (event) => { })

Alternatively, assign to the event handler property of the interface:

ongeometrychange = (event) => { }

Event type

A generic Event.

Examples

The following code snippet uses the geometrychange event to detect when the virtual keyboard geometry changes, and then accesses the boundingRect property to query the size and position of the virtual keyboard:

if ("virtualKeyboard" in navigator) {
  navigator.virtualKeyboard.overlaysContent = true;

  navigator.virtualKeyboard.addEventListener("geometrychange", (event) => {
    const { x, y, width, height } = event.target.boundingRect;
  });
}

Specifications

Browser compatibility

See also