Web/API/Keyboard/lock

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The lock() method of the Keyboard interface returns a Promise after enabling the capture of keypresses for any or all of the keys on the physical keyboard. This method can only capture keys that are granted access by the underlying operating system.

Syntax

var promise = Keyboard.lock([keyCodes[]])

Parameters

keyCodes Optional

An Array of one or more key codes to lock. If no keycodes are provided all keys will be locked. A list of valid code values is found in the UI Events KeyboardEvent code Values spec.

Return value

A Promise.

Examples

Capturing all keys

The following example captures all keypresses.

navigator.keyboard.lock();

Capturing specific keys

The following example captures the "W", "A", "S", and "D" keys. It captures these keys regardless of which modifiers are used with the key press. Assuming a standard US QWERTY layout, registering "KeyW" ensures that "W", Shift+"W", Control+"W", Control+Shift+"W", and all other key modifier combinations with "W" are sent to the app. The same applies to for "KeyA", "KeyS" and "KeyD".

navigator.keyboard.lock(["KeyW", "KeyA", "KeyS", "KeyD"]);

Specifications

Specification	Status	Comment
' Keyboard LockThe definition of 'lock()' in that specification.	Editor's Draft	Initial definition.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
lock Experimental'	Chrome Full support 68	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 55	Safari No support No	WebView Android No support No	Chrome Android No support No	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android No support No

Legend

Full support  

Full support

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

Keyboard.lock() by Mozilla Contributors is licensed under CC-BY-SA 2.5.