Screen wake lock
The wakeLock read-only property of the Navigator interface returns a WakeLock interface that allows a document to acquire a screen wake lock. While a screen wake lock is active, the user agent will try to prevent the device from dimming the screen, turning it off completely, or showing a screensaver.
Browser support
| Feature | Desktop | Mobile | ||||
|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Safari | Chrome Android | Safari iOS | |
| 84 | 84 | 126 | 16.4 | 84 | 18.4 | |
| HTML attribute | ||||||
allow (screen-wake-lock) | 84 | 84 | 126 | 16.4 | 84 | 16.4 |
| DOM API | ||||||
| The wakeLock read-only property of the Navigator interface returns a WakeLock interface that allows a document to acquire a screen wake lock. While a screen wake lock is active, the user agent will try to prevent the device from dimming the screen, turning it off completely, or showing a screensaver. | 84 | 84 | 126 | 16.4 | 84 | 18.4 |
permission_screen-wake-lock `screen-wake-lock` permission | 84 | 84 | 126 | 16.4 | 84 | 16.4 |
| The request() method of the WakeLock interface returns a Promise that fulfills with a WakeLockSentinel object if the system screen wake lock is granted. | 84 | 84 | 126 | 16.4 | 84 | 18.4 |
| The WakeLockSentinel interface of the Screen Wake Lock API can be used to monitor the status of the platform screen wake lock, and manually release the lock when needed. | 84 | 84 | 126 | 16.4 | 84 | 18.4 |
| The release() method of the WakeLockSentinel interface releases the WakeLockSentinel, returning a Promise that is resolved once the sentinel has been successfully released. | 84 | 84 | 126 | 16.4 | 84 | 18.4 |
| The release event of the WakeLockSentinel interface is fired when the sentinel object's handle has been released. | 84 | 84 | 126 | 16.4 | 84 | 18.4 |
| The released read-only property of the WakeLockSentinel interface returns a boolean that indicates whether a WakeLockSentinel has been released. | 87 | 87 | 126 | 16.4 | 87 | 18.4 |
| The type read-only property of the WakeLockSentinel interface returns a string representation of the currently acquired WakeLockSentinel type. | 84 | 84 | 126 | 16.4 | 84 | 18.4 |
| Other | ||||||
screen-wake-lock Experimental The HTTP Permissions-Policy header screen-wake-lock directive controls whether the current document is allowed to use Screen Wake Lock API to indicate that the device should not dim or turn off the screen. | 88 | 88 | | | 88 | |
- This browser only partially implements this feature
- This feature was removed in a later browser version (18.4)
- Does not work in standalone Home Screen Web Apps. See bug 254545.
- This browser only partially implements this feature
- This feature was removed in a later browser version (18.4)
- Does not work in standalone Home Screen Web Apps. See bug 254545.
- This browser only partially implements this feature
- This feature was removed in a later browser version (126)
- The value is recognized, but has no effect.
- This browser only partially implements this feature
- This feature was removed in a later browser version (18.4)
- Does not work in standalone Home Screen Web Apps. See bug 254545.
- This browser only partially implements this feature
- This feature was removed in a later browser version (18.4)
- Does not work in standalone Home Screen Web Apps. See bug 254545.
- This browser only partially implements this feature
- This feature was removed in a later browser version (18.4)
- Does not work in standalone Home Screen Web Apps. See bug 254545.
- This browser only partially implements this feature
- This feature was removed in a later browser version (18.4)
- Does not work in standalone Home Screen Web Apps. See bug 254545.
- This browser only partially implements this feature
- This feature was removed in a later browser version (18.4)
- Does not work in standalone Home Screen Web Apps. See bug 254545.
- This browser only partially implements this feature
- This feature was removed in a later browser version (18.4)
- Does not work in standalone Home Screen Web Apps. See bug 254545.
Use cases
-
Using Screen wake lock
The wakeLock read-only property of the Navigator interface returns a WakeLock interface that allows a document to acquire a screen wake lock.
Cautions
- May not be supported in older browsers.
Implementation notes
- Some APIs require a secure context (HTTPS) or user activation. Check the requirements before use.