vant/packages/vant/docs/markdown/use-page-visibility.en-US.md

usePageVisibility

Intro

Get the visible state of the page.

Usage

Basic Usage

import { watch } from 'vue';
import { usePageVisibility } from '@vant/use';

export default {
  setup() {
    const pageVisibility = usePageVisibility();

    watch(pageVisibility, (value) => {
      console.log('visibility: ', value);
    });
  },
};

API

Type Declarations

type VisibilityState = 'visible' | 'hidden';

function usePageVisibility(): Ref<VisibilityState>;

Return Value

Name	Description	Type
visibilityState	The current visible state of the page, could be visible or hidden	Ref<VisibilityState>