Loading source
Pulling the file list, source metadata, and syntax-aware rendering for this listing.
Source from repo
Apply VueUse composables in Vue 3/Nuxt projects to replace custom implementations with battle-tested utilities.
Files
Skill
Size
Entrypoint
Format
Open file
Syntax-highlighted preview of this file as included in the skill package.
references/useDocumentVisibility.md
1---2category: Elements3---45# useDocumentVisibility67Reactively track [`document.visibilityState`](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState)89## Usage1011```vue12<script setup lang="ts">13import { useDocumentVisibility } from '@vueuse/core'1415const visibility = useDocumentVisibility()16</script>17```1819## Component Usage2021```vue22<template>23<UseDocumentVisibility v-slot="{ visibility }">24Document Visibility: {{ visibility }}25</UseDocumentVisibility>26</template>27```2829## Type Declarations3031```ts32export interface UseDocumentVisibilityOptions extends ConfigurableDocument {}33export type UseDocumentVisibilityReturn = ShallowRef<DocumentVisibilityState>34/**35* Reactively track `document.visibilityState`.36*37* @see https://vueuse.org/useDocumentVisibility38*39* @__NO_SIDE_EFFECTS__40*/41export declare function useDocumentVisibility(42options?: UseDocumentVisibilityOptions,43): UseDocumentVisibilityReturn44```45