1.0.0 • Published 4 years ago

@ej-hooks/use-prevent-leave v1.0.0

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

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

npm

npm i @ej-hooks/use-prevent-leave

Usage

import React from 'react';
import usePreventLeave from '@ej-hooks/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