⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	5
📊 Variables & Constants	1

📚 Table of Contents

• Imports
• Variables & Constants
• Functions

🛠️ File Location:

📂 packages/core/useWindowFocus/index.ts

📦 Imports

Name	Source
ShallowRef	vue
ConfigurableWindow	../_configurable
shallowRef	vue
defaultWindow	../_configurable
useEventListener	../useEventListener

---

Variables & Constants

Name	Type	Kind	Value	Exported
listenerOptions	{ passive: boolean; }	const	{ passive: true }	✗

---

Functions

useWindowFocus(options: ConfigurableWindow): ShallowRef<boolean>

Code

export function useWindowFocus(options: ConfigurableWindow = {}): ShallowRef<boolean> {
  const { window = defaultWindow } = options
  if (!window)
    return shallowRef(false)

  const focused = shallowRef(window.document.hasFocus())

  const listenerOptions = { passive: true }

  useEventListener(window, 'blur', () => {
    focused.value = false
  }, listenerOptions)

  useEventListener(window, 'focus', () => {
    focused.value = true
  }, listenerOptions)

  return focused
}

• JSDoc:

  /**
   * Reactively track window focus with `window.onfocus` and `window.onblur`.
   *
   * @see https://vueuse.org/useWindowFocus
   */
  

• Parameters:

• options: ConfigurableWindow
• Return Type: ShallowRef<boolean>
• Calls:
• shallowRef (from vue)
• window.document.hasFocus
• useEventListener (from ../useEventListener)

---