Repository navigation
docs: fix afterRenderEffect phase example in the effect guide - #71091
Merged
atscott merged 1 commit intoSep 30, 2026
Merged
Conversation
The render phases section said phases are specified by passing an object with a `phase` property to `afterRender` or `afterNextRender`. `afterRender` was renamed to `afterEveryRender` and the `phase` option no longer exists; the example shows the spec object accepted by `afterRenderEffect`. Also fix `nativeElement` being called as a function in the chart example.
JeanMeche
approved these changes
Sep 30, 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 "Render phases" section says that a phase is specified by passing an object with a
phaseproperty toafterRenderorafterNextRender, but the example below usesafterRenderEffectwith one callback for each phase.Neither the
afterRendername nor thephaseoption matches the current API.afterRenderwas renamed toafterEveryRenderin #60999, and the phase option was replaced by the per-phase callback object in #55648.The chart example above also calls
this.canvas().nativeElement()even thoughnativeElementis a property ofElementRef, not a method.What is the new behavior?
The description now matches the current
afterRenderEffectAPI by explaining that phases are specified with an object containing a callback for each phase.The chart example also uses
this.canvas().nativeElement.Does this PR introduce a breaking change?
Other information
Docs-only change in
adev/src/content/guide/signals/effect.md.