W3cubDocs

/Web APIs

VirtualKeyboard: overlaysContent property

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The overlaysContent property of the VirtualKeyboard interface can be used to opt out of the automatic way in which browsers handle on-screen virtual keyboards by reducing the size of the viewport to make space for them.

If the overlaysContent property is set to true, the browser no longer resizes the viewport when the virtual keyboard appears. The virtual keyboard instead overlays the content of the web page, and you can adapt the page layout as appropriate using the Virtual Keyboard API and your own custom CSS and JavaScript.

Value

A boolean. false by default, set it to true to opt out of the browser's automatic handling of the on-screen virtual keyboard.

Example

js

if ("virtualKeyboard" in navigator) {
  console.log(navigator.virtualKeyboard.overlaysContent); // false
  navigator.virtualKeyboard.overlaysContent = true; // Opt out of the automatic handling.
}

Specifications

Specification
VirtualKeyboard API
# dom-virtualkeyboard-overlayscontent

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
overlaysContent 94 94 No No 80 No 94 94 No 66 No 17.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/VirtualKeyboard/overlaysContent