Licence
MIT
Version
1.0.0
Deps
0
Size
2 kB
Vulns
0
Weekly
0
@loyhooks/use-before-leave
React Hook to execute a function when the mouse leaves the page. Useful to show a popup or for analytics.
Installation
yarn
yarn add @loyhooks/use-before-leave
npm
npm i @loyhooks/use-before-leave
Usage
import React from "react";
import useBeforeLeave from "@loyhooks/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 |