usePageLeave
Reactive state to show whether the mouse leaves the page.
Demo
{
"isLeft": false
}Usage
ts
import { usePageLeave } from '@vueuse/core'
const isLeft = usePageLeave()Component Usage
This function also provides a renderless component version via the
@vueuse/componentspackage. Learn more about the usage.
vue
<template>
<UsePageLeave v-slot="{ isLeft }">
Has Left Page: {{ isLeft }}
</UsePageLeave>
</template>Type Declarations
ts
/**
* Reactive state to show whether mouse leaves the page.
*
* @see https://vueuse.org/usePageLeave
* @param options
*
* @__NO_SIDE_EFFECTS__
*/
export declare function usePageLeave(
options?: ConfigurableWindow,
): ShallowRef<boolean, boolean>
export type UsePageLeaveReturn = ReturnType<typeof usePageLeave>Source
Contributors
Anthony Fu
SerKo
IlyaL
Fernando Fernández
Anthony Fu
vaakian X
lxhyl
wheat
Alex Kozack
Antério Vieira