kliping.pro
  • Docs
  • Directory
  • Colors
  • Typeset
Hooks
  • State7
  • Advanced6
  • Lifecycle16
  • Browser21
    • useActiveElement
    • useBattery
    • useClickAnyWhere
    • useClickAway
    • useClipboard
    • useDocumentVisibility
    • useElementSize
    • useEventListener
    • useFps
    • useFullscreen
    • useHash
    • useHover
    • useInViewport
    • useIsMatchMedia
    • useIsOnline
    • useMouse
    • useNetwork
    • useOs
    • useScrollLock
    • useTextSelection
    • useTitle
  • Development1
  • Third-Party4
  • Libraries4

useDocumentVisibility

PreviousNext

Apakah tab-nya sedang dilihat.

Dipakai untuk berhenti bekerja saat tidak ada yang melihat: hentikan polling, jeda animasi, tunda muat ulang. Berpasangan rapi dengan useInterval, yang berhenti kalau jedanya null:

ts
const terlihat = useDocumentVisibility()
useInterval(muatUlang, () => (terlihat.value === 'visible' ? 5000 : null))

Nilainya visible saat dirender di server — bukan tebakan, melainkan satu- satunya jawaban yang membuat HTML server dan gambaran pertama di peramban cocok untuk tab yang memang sedang dibuka.

Installation ​

pnpm dlx shadcn-vue@latest add @kliping/use-document-visibility

Perlu @kliping terdaftar di components.json project Anda. Lihat cara menyiapkannya.

Ikut terpasang sendiri: is-browser, try-on-mounted, use-event-listener.

Salin dulu is-browser, try-on-mounted, target, use-event-listener — masing-masing memuat sumbernya di halamannya sendiri — lalu tempel berkas ini.

ts
import { readonly, ref } from 'vue'
import { isBrowser } from '@/lib/is-browser'
import { tryOnMounted } from '@/lib/try-on-mounted'
import { useEventListener } from '@/composables/use-event-listener'

export function useDocumentVisibility() {
  const visibility = ref<DocumentVisibilityState>('visible')

  const update = () => {
    if (isBrowser) visibility.value = document.visibilityState
  }

  tryOnMounted(update)
  useEventListener('visibilitychange', update, {
    target: isBrowser ? document : undefined,
    passive: true,
  })

  return readonly(visibility)
}

API ​

ts
export function useDocumentVisibility()
PrevioususeClipboardNext useElementSize

On This Page

InstallationAPI
Dirilis di bawah lisensi MIT. Ditulis ulang untuk Vue dari shadcn-vue, shadcn-ui-blocks, dan shadcn-hooks. Hak cipta © 2026 Kliping