Error: NextRouter was not mounted

Shivan M.

The Problem

When using the useRouter hook in Next.js 13 or later, you may encounter the following error:

Error: NextRouter was not mounted

This error can occur in one of two ways:

  1. When a component uses the useRouter hook outside of a Next.js application, or when a router is rendered outside of a Next.js application - like during unit testing.
  2. When trying to use the useRouter hook from the next/router package when using the App Directory. This is because the App Router (from next/navigation) has a different behavior from the useRouter hook used in pages.

The Solution

Ensure you are using the correct useRouter hook. If you are using the App Directory, check that the useRouter hook is imported from next/navigation and not from next/router.

When using the useRouter hook from next/navigation, use the following guidelines:

  • Instead of pathname, use the usePathname() hook.
  • Instead of the query object, use the useSearchParams() hook.

Mock next/navigation When Writing Unit Tests

The above error can also occur when using the useRouter hook from next/navigation in unit tests. It might be a good idea to use the next-router-mock package to mock it.

Ensure you mock the new hooks, usePathname() and useSearchParams(), for example:

const nextRouterMock = require('next-router-mock') jest.mock('next/navigation', () => { const { useRouter } = nextRouterMock const usePathname = () => { const router = useRouter() return router.pathname } const useSearchParams = () => { const router = useRouter() return new URLSearchParams(router.query) } return { useRouter, usePathname, useSearchParams } })

Get Started With Sentry

Get actionable, code-level insights to resolve Next.js performance bottlenecks and errors.

Run the line of code below to:

  1. Create a free Sentry account

  2. Run the CLI install command to automatically add the Sentry SDK to your project:

    npx @sentry/wizard@latest -i nextjs
  3. Start capturing errors and performance issues

Check our documentation for the latest instructions.

Loved by over 4 million developers and more than 90,000 organizations worldwide, Sentry provides code-level observability to many of the world’s best-known companies like Disney, Peloton, Cloudflare, Eventbrite, Slack, Supercell, and Rockstar Games. Each month we process billions of exceptions from the most popular products on the internet.

Share on Twitter
Bookmark this page
Ask a questionJoin the discussion

Related Answers

A better experience for your users. An easier life for your developers.

© 2024 • Sentry is a registered Trademark
of Functional Software, Inc.