Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarified "one level deep" in Hydration Mismatch Documentation #7212

Closed

Conversation

mudassir-jmi
Copy link

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.``

Copy link

vercel bot commented Oct 7, 2024

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

Name Status Preview Comments Updated (UTC)
19-react-dev ❌ Failed (Inspect) Oct 7, 2024 11:24am
react-dev ❌ Failed (Inspect) Oct 7, 2024 11:24am

@facebook-github-bot
Copy link
Collaborator

Hi @mudassir-jmi!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants