moeka-project/.agents/skills/vueuse-functions/references/useWindowFocus.md

category

category
Elements

useWindowFocus

Reactively track window focus with window.onfocus and window.onblur events.

Usage

<script setup lang="ts">
import { useWindowFocus } from '@vueuse/core'

const focused = useWindowFocus()
</script>

<template>
  <div>{{ focused }}</div>
</template>

Component Usage

<template>
  <UseWindowFocus v-slot="{ focused }">
    Document Focus: {{ focused }}
  </UseWindowFocus>
</template>

Type Declarations

/**
 * Reactively track window focus with `window.onfocus` and `window.onblur`.
 *
 * @see https://vueuse.org/useWindowFocus
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useWindowFocus(
  options?: ConfigurableWindow,
): ShallowRef<boolean>