usePageLeave

Demo

{
  "isLeft": false
}

Usage

import { usePageLeave } from '@vueuse/core'

const isLeft = usePageLeave()

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.

html

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

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

Type Declarations

typescript

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

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