useDocumentVisibility

监听页面是否可见,参考 visibilityState APIopen in new window

代码演示

基础用法

documentVisibility-history:
当前状态:visible
点击查看代码
<script setup>
import { useDocumentVisibility } from "ahooks-for-vue";
import { ref } from "vue";
const list = ref([]);
const { documentVisibility } = useDocumentVisibility((v) => {
  list.value.push(v);
});
</script>
<template>
  <div>documentVisibility-history: {{ list.join(",") }}</div>
  当前状态:{{ documentVisibility }}
</template>
<style></style>

API

const { documentVisibility } = useDocumentVisibility();

Result

参数说明类型
documentVisibility判断 document 是否处于可见状态Ref<visible| hidden | prerender> | undefined

Params

参数说明类型
callBack回调函数( documentVisibility ) => void)

Result 相比ahooks新增的APi

参数说明类型
restart重新开始监听函数() => void
stop移除监听函数() => void
Last Updated:
Contributors: 郑磊