Add suppressHydrationWarning for nextJS

[sylwit]

Using darkMode can lead to an hydratation warning.

As described in nextjs doc While rendering your application, there was a difference between the React tree that was pre-rendered from the server and the React tree that was rendered during the first render in the browser (hydration).

https://nextjs.org/docs/messages/react-hydration-error

https://github.com/pacocoursey/next-themes?tab=readme-ov-file#with-app

Summary by CodeRabbit

• Documentation
  • Updated the Next.js guide to include information on suppressing hydration warnings in RootLayout and Document components.

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1841777

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
flowbite-react	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 31, 2024 3:36pm
flowbite-react-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 31, 2024 3:36pm

[coderabbitai]

Walkthrough

This update introduces the suppressHydrationWarning property to both the html component within the RootLayout function and the Html component within the Document function. This change is aimed at improving the developer experience by suppressing hydration warnings that can clutter the console during development.

Changes

File Path	Change Summary
.../next-js.mdx	Added suppressHydrationWarning to html and Html components in respective functions.

🐰✨
In the land of code and flux,
A small change makes a big deluxe.
No more warnings to make us frown,
With suppressHydrationWarning we wear the crown.
Hop along, dear devs, with glee,
For cleaner consoles, as it should be.
🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cccda3e and 1841777.

Files selected for processing (1)

• apps/web/content/docs/guides/next-js.mdx (2 hunks)

Additional Context Used

Additional comments not posted (2)

apps/web/content/docs/guides/next-js.mdx (2)

149-149: Adding suppressHydrationWarning to the html element in the RootLayout function is a direct approach to suppress hydration warnings. However, it's important to ensure that this does not mask other potential issues in your application. Use this property judiciously and only when you're certain that the hydration mismatches are intentional and harmless.

---

168-168: Similarly, adding suppressHydrationWarning to the Html component in the Document function is an effective way to suppress hydration warnings. As with the previous comment, ensure that this approach is used carefully to avoid overlooking other discrepancies between server and client renders that could affect your application's behavior or performance.