Draft This page is not complete.
Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The WakeLock
interface of the Screen Wake Lock API
prevents device screens from dimming or locking when an application needs to keep running.
The system wake lock is exposed through the global Navigator.wakelock
property.
Methods
request
- Requests a
WakeLockSentinel
object, which returns aPromise
that resolves with aWakeLockSentinel
object.
Examples
The following asynchronous function requests a WakeLockSentinel
object. The WakeLock.request
method is wrapped in a try...catch
statement to account for if the browser refuses the request for any reason.
try {
const wakeLock = await navigator.wakeLock.request('screen');
} catch (err) {
// the wake lock request fails - usually system related, such being low on battery
console.log(`${err.name}, ${err.message}`);
}
Specifications
Specification | Status | Comment |
Screen Wake Lock APIThe definition of 'WakeLock' 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
Full support 84 |
Edge
Full support 84 |
Firefox
No support No |
IE
No support No |
Opera
Full support Yes |
Safari
No support No |
WebView Android
Full support 84 |
Chrome Android
Full support 84 |
Firefox Android
No support No |
Opera Android
Full support Yes |
Safari iOS
No support No |
Samsung Internet Android
No support No |
Chrome
Full support 84 |
Edge
Full support 84 |
Firefox
No support No |
IE
No support No |
Opera
Full support Yes |
Safari
No support No |
WebView Android
Full support 84 |
Chrome Android
Full support 84 |
Firefox Android
No support No |
Opera Android
Full support Yes |
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.
WakeLock by Mozilla Contributors is licensed under CC-BY-SA 2.5.