stack/v1/packages/mosaic/framework/skills/vueuse-functions/references/usePageLeave.md

category

category
Sensors

usePageLeave

Reactive state to show whether the mouse leaves the page.

Usage

import { usePageLeave } from '@vueuse/core';

const isLeft = usePageLeave();

Component 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
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function usePageLeave(options?: ConfigurableWindow): ShallowRef<boolean, boolean>;
export type UsePageLeaveReturn = ReturnType<typeof usePageLeave>;