@j-hooks/use-prevent-leave

1.0.0 • Public • Published

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

npm

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

Usage

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

/@j-hooks/use-prevent-leave/

    Package Sidebar

    Install

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

    Weekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    2.26 kB

    Total Files

    4

    Last publish

    Collaborators

    • justinhwang92