next-navigation-guard

Navigation Guard for Next.js App Router and Pages Router.

0.1.2

latest

Source

npm

Version published: 4 months ago

Weekly downloads: 24K

Maintainers: 0

Weekly downloads

Created: 7 months ago

Source

You use Next.js, and you want to show "You have unsaved changes that will be lost." dialog when user leaves page? This library is just for you!

Demo

https://layerxcom.github.io/next-navigation-guard/

How does it work?

Installation

npm install next-navigation-guard
# or
yarn install next-navigation-guard
# or
pnpm install next-navigation-guard

App Router: app/layout.tsx

<html lang="en">
  <body className={`${geistSans.variable} ${geistMono.variable}`}>
    <NavigationGuardProvider>{children}</NavigationGuardProvider>
  </body>
</html>

Page Router: page/_app.tsx

export default function MyApp({ Component, pageProps }: AppProps) {
  return (
    <NavigationGuardProvider>
      <Component {...pageProps} />
    </NavigationGuardProvider>
  );
}

Usage

window.confirm()

useNavigationGuard({ enabled: form.changed, confirm: () => window.confirm("You have unsaved changes that will be lost.") })

Custom dialog component

const navGuard = useNavigationGuard({ enabled: form.changed })

return (
  <>
    <YourContent />

    <Dialog open={navGuard.active}>
      <DialogText>You have unsaved changes that will be lost.</DialogText>

      <DialogActions>
        <DialogButton onClick={navGuard.reject}>Cancel</DialogButton>
        <DialogButton onClick={navGuard.accept}>Discard</DialogButton>
      </DialogActions>
    </Dialog>
  </>
)

See working example in example/ directory and its NavigationGuardToggle component.

FAQs

Package last updated on 11 Dec 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install