@jacob-hooks/use-prevent-leave

1.0.15 • Public • Published

@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

Dependencies (0)

    Dev Dependencies (0)

      Package Sidebar

      Install

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

      Weekly Downloads

      0

      Version

      1.0.15

      License

      MIT

      Unpacked Size

      4.14 kB

      Total Files

      6

      Last publish

      Collaborators

      • jacobko