@nooks/use-prevent-leave

1.0.1 • Public • Published

@nooks/use-prevent-leave

React Hook to prompt the user for confirmation before leaving the page. Useful when changes haven't been saved.

Installation

yarn

yarn add @nooks/use-prevent-leave

npm

npm i @nooks/use-prevent-leave

Usage

import React from "react";
import usePreventLeave from "@nooks/use-prevent-leave";

function App() {
  const { enablePrevent, disablePrevent } = usePreventLeave();
  const saveChanges = async () => {
    enablePrevent();
    await sendToApi();
    disablePrevent();
  };
  return <button onClick={saveChanges}>Save changes</button>;
}

Return

Return value Type Description
Functions Object A object containing functions enablePrevent and disablePrevent, use this functions to enable/disable the leaving prevention

Package Sidebar

Install

npm i @nooks/use-prevent-leave

Weekly Downloads

6

Version

1.0.1

License

MIT

Unpacked Size

2.2 kB

Total Files

4

Last publish

Collaborators

  • nomadcoders