useDocumentVisibility

Category

Elements

Export Size

599 B

Last Changed

2 months ago

Reactively track document.visibilityState

Demo

source

💡 Minimize the page or switch tab then return

Usage

import { useDocumentVisibility } from '@vueuse/core'

const visibility = useDocumentVisibility()

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
 */
export declare function useDocumentVisibility(
  options?: ConfigurableDocument,
): ShallowRef<DocumentVisibilityState>

Source

Source • Demo • Docs

Contributors

Anthony Fu

Anthony Fu

Antério Vieira

IlyaL

James Garbutt

Fernando Fernández

vaakian X

Jelf

Shinigami

wheat

Alex Kozack

Scott Bedard

Changelog

v12.4.0 on 1/10/2025

dd316 - feat: use passive event handlers everywhere is possible (#4477)

v12.0.0-beta.1 on 11/21/2024

0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)