useDocumentVisibility
Reactively track document.visibilityState
Usage
<script setup lang="ts">
import { useDocumentVisibility } from '@vueuse/core'
const visibility = useDocumentVisibility()
</script>Component Usage
<template>
<UseDocumentVisibility v-slot="{ visibility }">
Document Visibility: {{ visibility }}
</UseDocumentVisibility>
</template>Type Declarations
export interface UseDocumentVisibilityOptions extends ConfigurableDocument {}
export type UseDocumentVisibilityReturn = ShallowRef<DocumentVisibilityState>
/**
* Reactively track `document.visibilityState`.
*
* @see https://vueuse.org/useDocumentVisibility
*
* @__NO_SIDE_EFFECTS__
*/
export declare function useDocumentVisibility(
options?: UseDocumentVisibilityOptions,
): UseDocumentVisibilityReturn