Update custom document docs to prepare for React 18. #33814
Merged
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
leerob
requested review from
huozhi,
ijjk,
padmaia,
shuding,
styfle and
timneutkens
as code owners
ijjk
reviewed
Feb 3, 2022
ijjk
reviewed
Feb 3, 2022
Co-authored-by: JJ Kasper <jj@jjsweb.site>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
ijjk
previously approved these changes
Feb 3, 2022
ijjk
approved these changes
Feb 3, 2022
natew
pushed a commit
to natew/next.js
that referenced
this pull request
Feb 16, 2022
To help prepare for React 18, I've found myself sharing the updated code snippet of `_document` linked in the [React 18 docs](https://nextjs.org/docs/advanced-features/react-18#react-server-components), which uses a function instead of a class. This PR updates the Custom Document docs to help prepare for this change, by encourage readers to use the new version, and listing more tangible examples of why you would override `_document` (`lang` on `html`, className on `body`). It also reorganizes some of the caveats and warnings related to `getInitialProps` usage to only be in the single section that applies to it. These overrides and ejections (`getInitialProps` and `renderPage`) only apply to a subset of the people looking to change document. Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
To help prepare for React 18, I've found myself sharing the updated code snippet of
_documentlinked in the React 18 docs, which uses a function instead of a class.This PR updates the Custom Document docs to help prepare for this change, by encourage readers to use the new version, and listing more tangible examples of why you would override
_document(langonhtml, className onbody). It also reorganizes some of the caveats and warnings related togetInitialPropsusage to only be in the single section that applies to it.These overrides and ejections (
getInitialPropsandrenderPage) only apply to a subset of the people looking to change document.