コンテンツへスキップ

usePageLeave

カテゴリ
エクスポートサイズ
576 B
最終更新日
先週

マウスがページから離れたかどうかを示すリアクティブな状態。

デモ

{
  "isLeft": false
}

使用方法

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

const isLeft = usePageLeave()

コンポーネントでの使用方法

この関数は、@vueuse/componentsパッケージを介してレンダーレスコンポーネントバージョンも提供します。使用方法の詳細はこちら

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

型定義

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

ソースコード

ソースコードデモドキュメント

コントリビューター

Anthony Fu
Anthony Fu
vaakian X
lxhyl
wheat
Alex Kozack
Antério Vieira

変更ログ

v12.0.0-beta.1 2024/11/21
0a9ed - feat!: Vue 2サポートの削除、バンドルの最適化、クリーンアップ (#4349)
v9.11.0 2023/1/17
d5321 - fix(components): defineComponentをpureとしてマーク (#2623)

MITライセンスの下でリリースされています。