@jacob-hooks/use-prevent-leave
v1.0.15
Published
React Hook to prompt the user for confirmation before leaving the page. Useful when changes haven't been saved.
Downloads
13
Readme
@jacob-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 @jacob-hooks/use-prevent-leave
npm
npm i @jacob-hooks/use-prevent-leave
Usage
import React from "react";
import usePreventLeave from "@jacob-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 value | Type | Description |
| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------- |
| Functions | Object | A object containing functions enablePrevent
and disablePrevent
, use this functions to enable/disable the leaving prevention |