@nooks/use-before-leave
v1.0.2
Published
React Hook to execute a function when the mouse leaves the document.
Downloads
12
Maintainers
Readme
@nooks/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 @nooks/use-before-leave
npm
npm i @nooks/use-before-leave
Usage
import React from "react";
import useBeforeLeave from "@nooks/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 |