Clarified 'one level deep' in hydration mismatch error documentation #7214
+19
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Size changes📦 Next.js Bundle Analysis for react-devThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request aims to enhance the React documentation regarding suppressing hydration mismatch errors by providing a clear definition of the term "one level deep."
Changes Made:
Updated the documentation under the "Suppressing unavoidable hydration mismatch errors" section to clarify that:
The suppression of hydration mismatch warnings only applies to the immediate children of the element with the suppressHydrationWarning={true} attribute.
This means that any nested children beyond the immediate level will not benefit from this suppression.
Rationale:
The current documentation may cause confusion for developers regarding the scope of the suppressHydrationWarning attribute.
Providing this clarification will help users better understand how to use this feature effectively and avoid potential pitfalls in their applications.
By making this change, we hope to improve the user experience for developers working with React, allowing them to implement hydration warnings more confidently and accurately.