Document missing react-dom server rendering and hydration options - #8632
Merged
Conversation
This adds the `formState`, `importMap`, `onHeaders`, and `maxHeadersLength` options to the `renderToPipeableStream` and `renderToReadableStream` reference pages, documents the object form of `nonce` for separate script and style nonces, and adds `importMap`, `onHeaders`, and `maxHeadersLength` to the `prerender` and `prerenderToNodeStream` pages. All of these options are supported in stable releases but were never documented. The `resumeAndPrerender` entries on the `react-dom/static` index were marked as experimental-only even though they ship in stable releases, so the badge is removed, and the `resumeAndPrerender` intro destructured a `postpone` property that is actually called `postponed`. The `resumeToPipeableStream` page no longer documents a `signal` option because the Node.js implementation neither types nor reads it, and it now documents the `onAllReady` callback that the implementation does support. The same page referred to `resume` in its intro and Returns section where it meant `resumeToPipeableStream`, and the `react-dom/server` index linked both resume entries to the `renderToPipeableStream` page; they now point at their own pages. Co-Authored-By: Claude Code (kimi-k3[1m]) <noreply@anthropic.com>
Size changesDetails📦 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! 🙌 |
eps1lon
changed the title
resume references
eps1lon
marked this pull request as ready for review
September 2, 2026 18:39
This adds the `formState` option to the `hydrateRoot` reference. The option carries the form state produced by a Server Function form submission so that `useActionState` with a `permalink` returns the submitted state during hydration instead of the initial state, and it must match the `formState` passed to the server renderer. The option shipped in React 19.0 but was never documented. Co-Authored-By: Claude Code (kimi-k3[1m]) <noreply@anthropic.com>
eps1lon
changed the title
resume references
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 documents the
formStateoption across the server rendering and hydration reference pages, and fills in other stable SSR options that were never documented.hydrateRootgainsformState, which carries the form state produced by a Server Function form submission so thatuseActionStatewith apermalinkreturns the submitted state during hydration instead of the initial state.renderToPipeableStreamandrenderToReadableStreamgainformState(the matching server side),importMap,onHeaders, andmaxHeadersLength, and the object form ofnoncefor separate script and style nonces.prerenderandprerenderToNodeStreamgainimportMap,onHeaders, andmaxHeadersLength. TheresumeAndPrerenderentries on thereact-dom/staticindex were marked as experimental-only even though they ship in stable releases, so the badge is removed, and theresumeAndPrerenderintro destructured apostponeproperty that is actually calledpostponed.The
resumeToPipeableStreampage no longer documents asignaloption because the Node.js implementation neither types nor reads it, and it now documents theonAllReadycallback that the implementation does support. The same page referred toresumein its intro and Returns section where it meantresumeToPipeableStream, and thereact-dom/serverindex linked both resume entries to therenderToPipeableStreampage; they now point at their own pages.