VirtualKeyboard: overlaysContent property
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.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
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
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 | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
overlaysContent
|
|
|
|
|
|
|
|
|
|
|
|
|
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.