Repository navigation
docs: update event replay section of the hydration guide - #71120
Merged
kirjs merged 1 commit intoOct 2, 2026
Merged
Conversation
JeanMeche
reviewed
Oct 1, 2026
GabeSilvaDev
force-pushed
the
docs/hydration-event-replay-default
branch
from
October 1, 2026 17:23
97af885 to
af8cb2f
Compare
JeanMeche
added
action: merge
JeanMeche
previously approved these changes
Oct 1, 2026
Since incremental hydration became the default in v22 and it enables event replay, `provideClientHydration()` already replays events. The hydration guide still told readers to enable event replay with `withEventReplay()`; it now explains that it's on by default and when `withEventReplay()` is still needed.
GabeSilvaDev
force-pushed
the
docs/hydration-event-replay-default
branch
from
October 1, 2026 22:25
af8cb2f to
2a44346
Compare
Contributor
Author
|
Sorry about that, my previous push didn't actually include the change. Your suggestion is applied now in 2a44346. |
JeanMeche
approved these changes
Oct 1, 2026
Contributor
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
3 participants
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
The "Capturing and replaying events" section of the hydration guide says event replay must be enabled with
provideClientHydration(withEventReplay()).Since #68092 (v22), incremental hydration is enabled by default by
provideClientHydration(), and it includeswithEventReplay(). The incremental hydration guide already reflects this and sayswithEventReplay()can be removed, but the hydration guide still presents it as required.What is the new behavior?
The section now says that event replay is enabled by default with
provideClientHydration(). It only showswithEventReplay()for apps that opt out of incremental hydration withwithNoIncrementalHydration().The redundant note about event replay being enabled automatically with incremental hydration is also removed.
Does this PR introduce a breaking change?
Other information
Docs-only change in
adev/src/content/guide/hydration.md.