@nooks/use-before-leave

1.0.2 • Public • Published

@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

Package Sidebar

Install

npm i @nooks/use-before-leave

Weekly Downloads

3

Version

1.0.2

License

MIT

Unpacked Size

1.97 kB

Total Files

4

Last publish

Collaborators

  • nomadcoders