Document: pointerlockerror event

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

The pointerlockerror event is fired when locking the pointer failed (for technical reasons or because the permission was denied).

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("pointerlockerror", (event) => { })

onpointerlockerror = (event) => { }

Event type

A generic Event.

Examples

Using addEventListener():

js
const para = document.querySelector("p");

document.addEventListener("pointerlockerror", (event) => {
  console.log("Error locking pointer");
});

Using the onpointerlockerror event handler property:

js
document.onpointerlockerror = (event) => {
  console.log("Error locking pointer");
};

Specifications

Specification
Pointer Lock 2.0
# pointerlockchange-and-pointerlockerror-events
Pointer Lock 2.0
# dom-document-onpointerlockerror

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
pointerlockerror event
Chrome – No support
Chrome 22 – 37 (Release date: 2012-09-25)
prefix
footnote Removed in 38 and later
prefix Implemented with the vendor prefix: webkit
Chrome – Full support
Chrome 36 (Release date: 2014-07-16)
footnote Full support
Edge – Full support
Edge 13 (Release date: 2015-11-12)
footnote Full support
Firefox – No support
Firefox 14 – 49 (Release date: 2012-07-17)
prefix
prefix Implemented with the vendor prefix: moz
Firefox – Full support
Firefox 50 (Release date: 2016-11-15)
footnote Full support
Opera – No support
Opera 15 – 24 (Release date: 2013-07-02)
prefix
footnote Removed in 25 and later
prefix Implemented with the vendor prefix: webkit
Opera – Full support
Opera 23 (Release date: 2014-07-22)
footnote Full support
Safari – Full support
Safari 10.1 (Release date: 2017-03-27)
footnote Full support
Chrome Android – No support
Chrome Android
footnote
footnote See bug 40290045
Firefox for Android – No support
Firefox for Android 14 – 49 (Release date: 2012-06-26)
prefix
prefix Implemented with the vendor prefix: moz
Firefox for Android – Full support
Firefox for Android 50 (Release date: 2016-11-15)
footnote Full support
Opera Android – No support
Opera Android
footnote
footnote See bug 40290045
Safari on iOS – No support
Safari on iOS
footnote No support
Samsung Internet – No support
Samsung Internet
footnote
footnote See bug 40290045
WebView Android – No support
WebView Android
footnote
footnote See bug 40290045
WebView on iOS – No support
WebView on iOS
footnote No support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.
Requires a vendor prefix or different name for use.
Has more compatibility info.

See also