The KeyboardEvent.location read-only property returns an unsigned long representing the location of the key on the keyboard or other input device
Possible values are:
| Constant | Value | Description |
DOM_KEY_LOCATION_STANDARD |
0 | The key has only one version, or can't be distinguished between the left and right versions of the key, and was not pressed on the numeric keypad or a key that is considered to be part of the keypad. |
DOM_KEY_LOCATION_LEFT |
1 | The key was the left-hand version of the key; for example, the left-hand Control key was pressed on a standard 101 key US keyboard. This value is only used for keys that have more that one possible location on the keyboard. |
DOM_KEY_LOCATION_RIGHT |
2 | The key was the right-hand version of the key; for example, the right-hand Control key is pressed on a standard 101 key US keyboard. This value is only used for keys that have more that one possible location on the keyboard. |
DOM_KEY_LOCATION_NUMPAD |
3 |
The key was on the numeric keypad, or has a virtual key code that corresponds to the numeric keypad. Note: When NumLock is locked, Gecko always returns
DOM_KEY_LOCATION_NUMPAD for the keys on the numeric pad. Otherwise, when NumLock is unlocked and the keyboard actually has a numeric keypad, Gecko always returns DOM_KEY_LOCATION_NUMPAD too. On the other hand, if the keyboard doesn't have a keypad, such as on a notebook computer, some keys become Numpad only when NumLock is locked. When such keys fires key events, the location attribute value depends on the key. That is, it must not be DOM_KEY_LOCATION_NUMPAD.Note: NumLock key's key events indicate
DOM_KEY_LOCATION_STANDARD both on Gecko and Internet Explorer. |
DOM_KEY_LOCATION_MOBILE Obsolete since Gecko 38 |
4 |
The key was on a mobile device; this can be on either a physical keypad or a virtual keyboard. Note: Gecko always returns
DOM_KEY_LOCATION_MOBILE on Android (Prior to 18), Maemo, and Boot to Gecko. However, at Gecko 38, this is dropped. |
DOM_KEY_LOCATION_JOYSTICK Obsolete since Gecko 38 |
5 |
The key was a button on a game controller or a joystick on a mobile device. Note: Gecko never fires trusted key events with
DOM_KEY_LOCATION_JOYSTICK except on Android. Starting 18, native key events on Android may have this value. However, at Gecko 38, this is dropped. |
Syntax
var location = event.location;
Example
function keyEvent(event) {
console.log("Location of key pressed: " + event.location);
}
Specifications
| Specification | Status | Comment |
|---|---|---|
| Document Object Model (DOM) Level 3 Events Specification The definition of 'KeyboardEvent.location' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
| Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
|---|---|---|---|---|---|---|
| Basic support | (Yes) | (Yes) | 15.0 (15.0) | 9 | (Yes) | 6.1 (possibly earlier) |
| Feature | Android | Edge | Firefox Mobile (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | ? | (Yes) | 15.0 (15.0) | ? | ? | 8 |