--- title: 页面可见性 API slug: Web/API/Page_Visibility_API tags: - DOM - Intermediate - PageVisiblity translation_of: Web/API/Page_Visibility_API ---

{{DefaultAPISidebar("Page Visibility API")}}

使用选项卡式浏览，任何给定网页都有可能在后台，因此对用户不可见。页面可见性 API提供了您可以观察的事件，以便了解文档何时可见或隐藏，以及查看页面当前可见性状态的功能。

注意：页面可见性 API对于节省资源和提高性能特别有用，它使页面在文档不可见时避免执行不必要的任务。

当用户最小化窗口或切换到另一个选项卡时，API会发送{{event("visibilitychange")}}事件，让监听者知道页面状态已更改。你可以检测事件并执行某些操作或行为不同。例如，如果您的网络应用正在播放视频，则可以在用户将标签放入背景时暂停视频，并在用户返回标签时恢复播放。 用户不会在视频中丢失位置，视频的音轨不会干扰新前景选项卡中的音频，并且用户在此期间不会错过任何视频。

{{HTMLElement("iframe")}}的可见性状态与父文档相同。使用CSS属性（例如{{cssxref("display", "display: none;")}}）隐藏<iframe>不会触发可见性事件或更改框架中包含的文档的状态。

使用情景

一些例子：

开发者在过去使用不完善的代理来检测页面的可见性。比如，通过监听 {{event("blur")}} 和 {{event("focus")}} 事件来了解页面是否处于活动状态，但是它并没有告诉你页面是对用户隐藏的。页面可见性 API 解决了这个问题。

注意：虽然{{domxref("GlobalEventHandlers.onblur", "onblur")}}和{{domxref("GlobalEventHandlers.onfocus", "onfocus")}}会告诉你用户是否切换窗口，但不一定意味着它是隐藏的。当用户切换选项卡或最小化包含选项卡的浏览器窗口时，页面才会隐藏。

制定有助于后台页面性能的策略

在页面可见性API之外，用户代理会采取许多策略来减轻背景或隐藏选项卡对性能的影响。这些可能包括：

Some processes are exempt from this throttling behavior. In these cases, you can use the Page Visibility API to reduce the tabs' performance impact while they're hidden.

示例

看一个 在线的例子 （带声音的视频）

在此例中，当你切换到另一个标签时视频会暂停，当你返回到当前标签时视频会再次播放，代码如下：

// 设置隐藏属性和改变可见属性的事件的名称
var hidden, visibilityChange;
if (typeof document.hidden !== "undefined") { // Opera 12.10 and Firefox 18 and later support
  hidden = "hidden";
  visibilityChange = "visibilitychange";
} else if (typeof document.msHidden !== "undefined") {
  hidden = "msHidden";
  visibilityChange = "msvisibilitychange";
} else if (typeof document.webkitHidden !== "undefined") {
  hidden = "webkitHidden";
  visibilityChange = "webkitvisibilitychange";
}

var videoElement = document.getElementById("videoElement");

// 如果页面是隐藏状态，则暂停视频
// 如果页面是展示状态，则播放视频
function handleVisibilityChange() {
  if (document[hidden]) {
    videoElement.pause();
  } else {
    videoElement.play();
  }
}

// 如果浏览器不支持addEventListener 或 Page Visibility API 给出警告
if (typeof document.addEventListener === "undefined" || typeof document[hidden] === "undefined") {
  console.log("This demo requires a browser, such as Google Chrome or Firefox, that supports the Page Visibility API.");
} else {
  // 处理页面可见属性的改变
  document.addEventListener(visibilityChange, handleVisibilityChange, false);

  // 当视频暂停，设置title
  // This shows the paused
  videoElement.addEventListener("pause", function(){
    document.title = 'Paused';
  }, false);

  // 当视频播放，设置title
  videoElement.addEventListener("play", function(){
    document.title = 'Playing';
  }, false);

}

属性

{{domxref("Document.hidden")}} {{ReadOnlyInline}}
如果页面处于被认为是对用户隐藏状态时返回true，否则返回false。
{{domxref("Document.visibilityState")}} {{ReadOnlyInline}}
是一个用来展示文档当前的可见性的{{domxref("DOMString")}} 。该属性的值为以下值之一：
{{domxref("Document.onvisibilitychange")}}
{{domxref("EventListener")}} 提供在{{event("visibilitychange")}} 事件被触发时要调用的代码。
//startSimulation 和 pauseSimulation 在其他地方定义
function handleVisibilityChange() {
  if (document.hidden) {
    pauseSimulation();
  } else  {
    startSimulation();
  }
}

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

规范

Specification Status Comment
{{SpecName('Page Visibility API')}} {{Spec2('Page Visibility API')}} Initial definition.

浏览器兼容性

Document.visibilityState

{{Compat("api.Document.visibilityState")}}

参考