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

npm

npm i @custom_react_hook/use-prevent-leave

Usage

import React from "react";
import usePreventLeave from "@custom_react_hook/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 |