1.0.0 • Published 3 years ago

@hookplus/use-prevent v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

@hookplus/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 @hookplus/use-prevent-leave

npm

npm i @hookplus/use-prevent-leave

Usage

import React from "react";
import usePreventLeave from "@hookplus/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 valueTypeDescription
FunctionsObjectA object containing functions enablePrevent and disablePrevent, use this functions to enable/disable the leaving prevention