@bro95-hooks/use-before-leave
v1.0.0
Published
React Hook to execute a function when the mouse leaves the page. Useful to show a popup or for analytics.
Downloads
3
Maintainers
Readme
@bro95-hooks/use-before-leave
📌React Hook to execute a function when the mouse leaves the page. Useful to show a popup or for analytics.
Installation
npm
npm i @bro95-hooks/use-before-leave
Usage
import React from "react";
import useBeforeLeave from "@bro95-hooks/use-before-leave";
function App() {
const beforeLeave = () => console.log("User is leaving...");
useBeforeLeave(beforeLeave);
return <h1>Hello Nooks</h1>;
}
Arguments
| Argument | Type | Description | Required | | ------------- | -------- | -------------------------------------------------------- | -------- | | onBeforeLeave | function | Function to be called when the mouse leaves the document | yes |