Element.requestFullscreen()
Element.requestFullscreen()
方法用于发出异步请求使元素进入全屏模式。
调用此 API 并不能保证元素一定能够进入全屏模式。如果元素被允许进入全屏幕模式,返回的Promise
会 resolve,并且该元素会收到一个fullscreenchange
事件,通知它已经进入全屏模式。如果全屏请求被拒绝,返回的 promise 会变成 rejected 并且该元素会收到一个fullscreenerror
事件。如果该元素已经从原来的文档中分离,那么该文档将会收到这些事件。
语法
requestFullscreen()
requestFullscreen(options)
参数
options
可选
一个FullscreenOptions
(en-US)对象提供切换到全屏模式的控制选项。目前,唯一的选项是navigationUI
(en-US),这控制了是否在元素处于全屏模式时显示导航条 UI。默认值是"auto"
,表明这将由浏览器来决定是否显示导航条。
返回值
在完成切换全屏模式后,返回一个已经用值 undefined
resolved 的Promise
异常
requestFullscreen()
通过拒绝返回的 Promise
来生成错误条件,而不是抛出一个传统的异常。拒绝控制器接收以下的某一个值:
TypeError
-
在以下几种情况下,会抛出
TypeError
:- 文档中包含的元素未完全激活,也就是说不是当前活动的元素。
- 元素不在文档之内。
- 因为功能策略限制配置或其他访问控制,元素不被允许使用
"fullscreen"
功能。 - 元素和它的文档是同一个节点。
示例
在调用 requestFullScreen()
之前,可以对 fullscreenchange
和 fullscreenerror
事件进行监听,这样在请求进入全屏模式成功或者失败时都能收到事件通知。
规范
Specification |
---|
Fullscreen API Standard # ref-for-dom-element-requestfullscreen① |
浏览器兼容性
BCD tables only load in the browser