⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	5

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/core/useDocumentVisibility/index.ts

📦 Imports

Name	Source
ShallowRef	vue
ConfigurableDocument	../_configurable
shallowRef	vue
defaultDocument	../_configurable
useEventListener	../useEventListener

---

Functions

useDocumentVisibility(options: ConfigurableDocument): ShallowRef<DocumentVisibilityState>

Code

export function useDocumentVisibility(options: ConfigurableDocument = {}): ShallowRef<DocumentVisibilityState> {
  const { document = defaultDocument } = options
  if (!document)
    return shallowRef('visible')

  const visibility = shallowRef(document.visibilityState)

  useEventListener(document, 'visibilitychange', () => {
    visibility.value = document.visibilityState
  }, { passive: true })

  return visibility
}

• JSDoc:

  /**
   * Reactively track `document.visibilityState`.
   *
   * @see https://vueuse.org/useDocumentVisibility
   */
  

• Parameters:

• options: ConfigurableDocument
• Return Type: ShallowRef<DocumentVisibilityState>
• Calls:
• shallowRef (from vue)
• useEventListener (from ../useEventListener)

---