usePageLeave

Category

Sensors

Export Size

625 B

Last Changed

3 months ago

Reactive state to show whether the mouse leaves the page.

Demo

sourceplayground (beta)

{
  "isLeft": false
}

Usage

import { usePageLeave } from '@vueuse/core'

const isLeft = usePageLeave()

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

<template>
  <UsePageLeave v-slot="{ isLeft }">
    Has Left Page: {{ isLeft }}
  </UsePageLeave>
</template>

Type Declarations

/**
 * Reactive state to show whether mouse leaves the page.
 *
 * @see https://vueuse.org/usePageLeave
 * @param options
 */
export declare function usePageLeave(
  options?: ConfigurableWindow,
): ShallowRef<boolean, boolean>

Source

Source • Demo • Docs

Contributors

Anthony Fu

Fernando Fernández

Anthony Fu

vaakian X

lxhyl

wheat

Alex Kozack

Antério Vieira

Changelog

v12.4.0 on 1/10/2025

dd316 - feat: use passive event handlers everywhere is possible (#4477)

v12.0.0-beta.1 on 11/21/2024

0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)