This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Note: This API is still actively being developed and available only behind a flag on select browsers and platforms.
The HTTP Feature-Policy
header screen-wake-lock
directive controls whether the current document is allowed to use Screen Wake Lock API to indicate that device should not dim or turn off the screen.
Note: In earlier specification drafts this directive was called wake-lock
.
Syntax
Feature-Policy: screen-wake-lock <allowlist>;
- <allowlist>
An allowlist is a list of origins that takes one or more of the following values, separated by spaces:
*
: The feature will be allowed in this document, and all nested browsing contexts (iframes) regardless of their origin.'self'
: The feature will be allowed in this document, and in all nested browsing contexts (iframes) in the same origin.'src'
: (In an iframe allow attribute only) The feature will be allowed in this iframe, as long as the document loaded into it comes from the same origin as the URL in the iframe's src attribute.'none'
: The feature is disabled in top-level and nested browsing contexts.- <origin(s)>: The feature is allowed for specific origins (for example, https://example.com). Origins should be separated by a space.
The values
*
(enable for all origins) or'none'
(disable for all origins) may only be used alone, while'self'
and'src'
may be used with one or more origins.Features are each defined to have a default allowlist, which is one of:
*
: The feature is allowed by default in top-level browsing contexts and all nested browsing contexts (iframes).'self'
: The feature is allowed by default in top-level browsing contexts and in nested browsing contexts (iframes) in the same origin. The feature is not allowed in cross-origin documents in nested browsing contexts.'none'
: The feature is disabled in top-level and nested browsing contexts.
Default policy
Default allow list for screen-wake-lock
is 'self'
.
Specifications
Specification | Status | Comment |
---|---|---|
Feature Policy | Editor's Draft | Initial definition. |
Screen Wake Lock API | Editor's Draft | Initial definition of screen-wake-lock feature directive. |
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.
No compatibility data found. Please contribute data for "http.headers.Feature-Policy.screen-wake-lock" (depth: 1) to the MDN compatibility data repository.