useDocumentVisibility

Category

Elements

Export Size

692 B

Last Changed

4 days ago

Reactively track document.visibilityState

Demo

sourceplayground (beta)

💡 Minimize the page or switch tab then return

Usage

<script setup lang="ts">
import { useDocumentVisibility } from '@vueuse/core'

const visibility = useDocumentVisibility()
</script>

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

<template>
  <UseDocumentVisibility v-slot="{ visibility }">
    Document Visibility: {{ visibility }}
  </UseDocumentVisibility>
</template>

Type Declarations

/**
 * Reactively track `document.visibilityState`.
 *
 * @see https://vueuse.org/useDocumentVisibility
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useDocumentVisibility(
  options?: ConfigurableDocument,
): ShallowRef<DocumentVisibilityState>

Source

Source • Demo • Docs

Contributors

NoiseFan

Changelog

No recent changes