useWindowFocus

Category

Elements

Export Size

681 B

Last Changed

4 days ago

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

Demo

sourceplayground (beta)

💡 Click somewhere outside of the document to unfocus.

Usage

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

const focused = useWindowFocus()
</script>

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

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the 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>

Source

Source • Demo • Docs

Contributors

NoiseFan

Changelog

No recent changes