coderef

Virtual keyboardLimited availability

The navigator.virtualKeyboard API inspects and controls on-screen virtual keyboards. You can use it to programmatically hide or show a virtual keyboard or respond to the keyboard disappearing or appearing.

Not yet supported in all major browsers — check the table and provide a fallback.

How to use ↓Compare browsers

Browser support

DesktopChrome
1–93Not supported
94+Supportedsince Sep 21, 2021
Current: 155
Edge
12–93Not supported
94+Supportedsince Sep 24, 2021
Current: 154
Firefox
✕Not supportedup to 157
Current: 157
Safari
✕Not supportedup to 27
Current: 27
MobileChrome Android
18–93Not supported
94+Supportedsince Sep 21, 2021
Current: 155
Firefox Android
✕Not supportedup to 157
Current: 157
Safari iOS
✕Not supportedup to 27
Current: 27

How to use

Not supported in Firefox, Safari, Firefox Android, Safari iOS. Use feature detection below and provide a fallback (or a polyfill) for those browsers.

Example

Full syntax and examples are on MDN: virtualKeyboardPolicy.

Feature detection

JS · check before using
if ("VirtualKeyboard" in globalThis) {
  // VirtualKeyboard is available
} else {
  // load a polyfill or use a fallback
}

Documentation (MDN)

Specification

Sub-features

Support for each part of the feature (9). The overall table above shows when the whole feature works.

Sub-featureChromeEdgeFirefoxSafariChrome AndroidFirefox AndroidSafari iOS
HTMLElement.virtualKeyboardPolicy9494✕✕94✕✕
Navigator.virtualKeyboard9494✕✕94✕✕
VirtualKeyboard9494✕✕94✕✕
VirtualKeyboard.boundingRect9494✕✕94✕✕
VirtualKeyboard.geometrychange_event9494✕✕94✕✕
VirtualKeyboard.hide9494✕✕94✕✕
VirtualKeyboard.overlaysContent9494✕✕94✕✕
VirtualKeyboard.show9494✕✕94✕✕
virtualkeyboardpolicy9494✕✕94✕✕