-
Notifications
You must be signed in to change notification settings - Fork 22.4k
/
index.md
81 lines (57 loc) · 2.5 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
---
title: "Keyboard: lock() method"
short-title: lock()
slug: Web/API/Keyboard/lock
page-type: web-api-instance-method
status:
- experimental
browser-compat: api.Keyboard.lock
---
{{APIRef("Keyboard API")}}{{SeeCompatTable}}{{securecontext_header}}
The **`lock()`** method of the
{{domxref("Keyboard")}} interface returns a {{jsxref('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.
If `lock()` is called multiple times then only the key codes specified in the most recent call will be locked.
Any keys locked by a previous call to `lock()` are unlocked.
## Syntax
```js-nolint
lock()
lock(keyCodes)
```
### Parameters
- `keyCodes` {{optional_inline}}
- : An {{jsxref('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](https://w3c.github.io/uievents-code/#key-alphanumeric-writing-system) spec.
### Return value
A {{jsxref('Promise')}} that resolves with {{jsxref('undefined')}} when the lock was successful.
### Exceptions
- `AbortError` {{domxref("DOMException")}}
- : Thrown if a new call to `lock()` is made before the current one has finished.
- `InvalidAccessError` {{domxref("DOMException")}}
- : Thrown if any key in `keyCodes` is not a valid [key code attribute value](https://www.w3.org/TR/uievents-code/#key-code-attribute-value).
- `InvalidStateError` {{domxref("DOMException")}}
- : Thrown if `lock()` is not called in an active top-level browsing context.
## Security
[Transient user activation](/en-US/docs/Web/Security/User_activation) is required. The user has to interact with the page or a UI element in order for this feature to work.
## Examples
### Capturing all keys
The following example captures all keypresses.
```js
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"`.
```js
navigator.keyboard.lock(["KeyW", "KeyA", "KeyS", "KeyD"]);
```
## Specifications
{{Specifications}}
## Browser compatibility
{{Compat}}