Keyboard.lock()

Experimental

This is an experimental technology
Check 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

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
This is an experimental API that should not be used in production code. Unknown
The definition of 'lock()' in that specification.
Editor's Draft Initial definition.

Browser compatibility

BCD tables only load in the browser