Sentry Answers>Next.js>

Error: There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering

Error: There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering

Shivan M.

The Problem

When using Next.js 13 and the App directory, you might encounter the following error when using the <head> tag in your root component:

Click to Copy
Error: There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering

This occurs because Next.js controls the injection of metadata into the <head> tag of the HTML of your page during hydration. By using the <head> tag directly, the server-rendered HTML does not match what is on the client at the time of hydration.

The Solution

To resolve this error, you can instead use the custom Head component provided by Next.js:

Click to Copy
import Head from "next/head"; export default function Home() { return ( <main> <Head> <title>Test Title</title> </Head> <div> <h1>Hello World</h1> </div> </main> ); }

This tag allows you to inject your required attributes into the HTML of your page during hydration.

For additional guidance on fixing hydration errors, please see this answer

  • Community SeriesDebug Next.js with Sentry
  • ResourcesJavaScript Frontend Error Monitoring 101
  • ResourcesSentry vs. Crashlytics: The Mobile Developer's Decision-Making Guide
  • Syntax.fmListen to the Syntax Podcast
  • Syntax.fm logo
    Listen to the Syntax Podcast

    Tasty treats for web developers brought to you by Sentry. Get tips and tricks from Wes Bos and Scott Tolinski.

    SEE EPISODES

Considered “not bad” by 4 million developers and more than 100,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.

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