usePageLeave

Detect when the mouse leaves the page.

https://www.shaktools.com/shak-hooks

Sensor

API Reference

Installation

terminal

pnpm add @shak-hooks/usehooks

import.ts

import { usePageLeave } from "@shak-hooks/usehooks";

Source: packages/react/src/usePageLeave.ts

Signature

signature.ts

export function usePageLeave(onLeave: () => void)

Parameters

Name	Type	Optional	Default
onLeave	() => void	No	-

Returns

unknown

Implementation

use-page-leave.ts

1import { useEffect } from "react";

3export function usePageLeave(onPageLeave: () => void) {

4 useEffect(() => {

5 const handleMouseLeave = (event: MouseEvent) => {

6 if (event.clientY <= 0) {

7 onPageLeave();

8 }

9 };

11 document.addEventListener("mouseleave", handleMouseLeave);

12 return () => {

13 document.removeEventListener("mouseleave", handleMouseLeave);

14 };

15 }, [onPageLeave]);

16}

Google Ads

Usage

example.tsx

1import { usePageLeave } from "@shak-hooks/usehooks";

3const result = usePageLeave(undefined);

4// result: unknown

5// Use values directly (React state).