Abstract

This specification defines a means to programmatically determine the visibility state of a document. This can aid in the development of resource efficient web applications.

Status of This Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

Page Visibility Level 2 replaces the first version of [PAGE-VISIBILITY] and includes:

This document was published by the Web Performance Working Group as a Proposed Recommendation. This document is intended to become a W3C Recommendation. Comments regarding this document are welcome. Please send them to public-web-perf@w3.org (subscribe, archives) with [page-visibility] at the start of your email's subject, or file a bug on GitHub.

The W3C Membership and other interested parties are invited to review the document and send comments to public-web-perf@w3.org (subscribe, archives) or file a bug on GitHub through 14 November 2017. Advisory Committee Representatives should consult their WBS questionnaires. Note that substantive technical comments for Level 2 were expected during the Candidate Recommendation review period that ended 25 April 2017.

Please see the Working Group's implementation report.

Publication as a Proposed Recommendation does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

This document is governed by the 1 March 2017 W3C Process Document.

1. Introduction

This section is non-normative.

The Page Visibility API defines a means to programmatically determine the visibility state of a top level browsing context, and to be notified if the visibility state changes. Without knowing the visibility state of a page, web developers have been designing web pages as if they are always visible. This not only results in higher machine resource utilization, but it prevents web developers from making runtime decisions based on whether the web page is visible to the user. Designing web pages with knowledge of the page's visibility state can result in improved user experiences and power efficient sites.

With this API, web applications can choose to alter their behavior based on whether they are visible to the user or not. For example, this API can be used to scale back work when the page is no longer visible.

2. Conformance

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words MAY and MUST are to be interpreted as described in [RFC2119].

3. Examples of usage

This section is non-normative.

To improve the user experience and optimize CPU and power efficiency the application could autoplay a video when the application is visible, and automatically pause the playback when the application is hidden:

Example 1: Visibility-aware video playback
var videoElement = document.getElementById("videoElement");

// Autoplay the video if application is visible
if (document.visibilityState == "visible") {
  videoElement.play();
}

// Handle page visibility change events
function handleVisibilityChange() {
  if (document.visibilityState == "hidden") {
    videoElement.pause();
  } else {
    videoElement.play();
  }
}

document.addEventListener('visibilitychange', handleVisibilityChange, false);

Similar logic can be applied to intellegently pause and resume, or throttle, execution of application code such as animation loops, analytics, and other types of processing. By combining the visibilityState attribute of the Document interface and the visibilitychange event, the application is able to both query and listen to page visibility events to deliver a better user experience, as well as improve efficiency and performance of its execution.

4. Visibility states and the VisibilityState enum

The Document of the top level browsing context can be in one of the following visibility states:

hidden
The Document is not visible at all on any screen.
visible
The Document is at least partially visible on at least one screen. This is the same condition under which the hidden attribute is set to false.

The visibility states are reflected in the API via the VisibilityState enum. 

enum VisibilityState {
    "hidden",
    "visible"
};

5. Extensions to the Document interface

This specification extends the [HTML51] Document interface: 

partial interface Document {
    readonly attribute boolean         hidden;
    readonly attribute VisibilityState visibilityState;
             attribute EventHandler    onvisibilitychange;
};

5.1 hidden attribute

On getting, the hidden attribute MUST run the steps to determine if the document is hidden:

  1. If steps to determine the visibility state return visible, then return false.
  2. Otherwise, return true.
Note

Support for hidden attribute is maintained for historical reasons. Developers should use visibilityState where possible.

5.2 visibilityState attribute

On getting, the visibilityState attribute the user agent MUST run the steps to determine the visibility state:

  1. Let doc be the Document of the top level browsing context.
  2. If the defaultView of doc is null, return hidden.
  3. Otherwise, return the VisibilityState value that best matches the visibility state of doc:
    1. Return "visible" if:
      1. The user agent is not minimized and doc is the foreground tab.
      2. The user agent is fully obscured by an accessibility tool, like a magnifier, but a view of the doc is shown.
    2. Return "hidden" if:
      1. The user agent is minimized.
      2. The user agent is not minimized, but doc is on a background tab.
      3. The user agent is to unload doc.
      4. The Operating System lock screen is shown.

To accommodate assistive technologies that are typically full screen but still show a view of the page, when applicable, on getting, the [ visibilityState attribute MAY return visible, instead of hidden, when the user agent is not minimized but is fully obscured by other applications.

5.3 onvisiblitychange event handler

onvisibilitychange is an event handler IDL attribute for the visibilitychange event type.

6. Reacting to visibilitychange changes

The task source for these tasks is the user interaction task source.

When the user agent determines that the visibility of the Document of the top level browsing context has changed, the user agent MUST run the following steps:

  1. Let doc be the Document of the top level browsing context.
  2. If doc is now visible:
    1. If traversing to a session history entry, run the now visible algorithm before running the step to fire the pageshow event.
    2. Otherwise, queue a task that runs the now visible algorithm.
  3. Else if doc is now not visible, or if the user agent is to unload doc:
    1. If the user agent is to unload the Document, run the now hidden algorithm during the unloading document visibility change steps.
    2. Otherwise, queue a task that runs the now hidden algorithm.

The now visible algorithm runs the following steps synchronously:

  1. Let doc be the Document of the top level browsing context.
  2. Fire a simple event named visibilitychange that bubbles, isn't cancelable, and has no default action, at the doc.

The now hidden algorithm runs the following steps synchronously:

  1. Let doc be the Document of the top level browsing context.
  2. Fire a simple event named visibilitychange that bubbles, isn't cancelable, and has no default action, at the doc.

7. Privacy and Security

The Page Visibility API enables developers to know when a Document is visible or in focus. Existing mechanisms, such as the focus and blur events, when attached to the Window object already provide a mechanism to detect when the Document is the active document; the unload event provides a notification that the page is being unloaded.

8. Terminology

The following concepts and interfaces are defined in the [HTML51] specification:

The [DOM4] specification defines how to fire a simple event.

A. Acknowledgments

Thanks to Alex Komoroske, Arvind Jain, Boris Zbarsky, Cameron McCormack, James Robinson, Jason Weber, Jonas Sicking, Karen Anderson, Kyle Simpson, Nat Duca, Nic Jansma, Philippe Le Hegaret, and Todd Reifsteck for their contributions to this work.

B. References

B.1 Normative references

[DOM4]
W3C DOM4. Anne van Kesteren; Aryeh Gregor; Ms2ger; Alex Russell; Robin Berjon. W3C. 19 November 2015. W3C Recommendation. URL: https://www.w3.org/TR/2015/REC-dom-20151119/
[HTML51]
HTML 5.1. Steve Faulkner; Arron Eicholz; Travis Leithead; Alex Danilo. W3C. 1 November 2016. W3C Recommendation. URL: https://www.w3.org/TR/html51/
[RFC2119]
Key words for use in RFCs to Indicate Requirement Levels. S. Bradner. IETF. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119

B.2 Informative references

[PAGE-VISIBILITY]
Page Visibility (Second Edition). Jatinder Mann; Arvind Jain. W3C. 29 October 2013. W3C Recommendation. URL: https://www.w3.org/TR/page-visibility/
[WEBIDL]
Web IDL. Cameron McCormack; Boris Zbarsky; Tobie Langel. W3C. 15 December 2016. W3C Working Draft. URL: https://www.w3.org/TR/WebIDL-1/