npm screenfull 中文API

736 阅读1分钟

API 说明

functionName说明参数
.request(element, options?)全屏options 如下解释
.toggle(element, options?)全屏 和request用法一致,但是如果当前是全屏状态,再次调用 toggle将退出全屏
.exit()退出全屏
.on(event, function)监听Events: 'change' 'error'
.off(event, function)移除监听
onchange(function).on('change', function)的别名
.onerror(function).on('error', function)的别名
.isFullscreen是否是全屏状态boolean
.element返回当前全屏的节点
.isEnabled返回是否允许全屏iframe 需要添加allowfullscreen
.raw未包装过的全屏API
  • 参数 options 控制向全屏模式过渡的行为的对象

  • 选项navigationUI 控制在元素处于全屏模式时是否显示导航 UI。默认值为“auto”,表示浏览器应该决定做什么。

"hide":浏览器的导航界面将被隐藏,屏幕的整个尺寸将分配给元素的显示。 "show":浏览器将呈现页面导航控件和可能的其他用户界面;元素的尺寸(以及屏幕的感知尺寸)将被限制,以便为该用户界面留出空间。 "auto":浏览器将选择应用上述设置中的哪一个。这是默认值

  • eg:{ navigationUI: "show" }