docs(cdk/portal): clarify CdkPortal query pattern and use signal-based viewChild#32829
Open
yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
Open
docs(cdk/portal): clarify CdkPortal query pattern and use signal-based viewChild#32829yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
Conversation
…d viewChild Update the portal documentation to clarify that CdkPortal should be queried by class rather than template reference variable, which avoids the undefined result when using *cdkPortal structural directive syntax. Also update all code examples to use signal-based viewChild queries and inject() instead of decorator-based @ViewChild.
angular-robot
bot
added
area: docs
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.
What kind of change does this PR introduce?
Documentation improvement
What is the current behavior?
The portal documentation says a component can use
@ViewChildor@ViewChildrento get a reference to aCdkPortal, but does not show how. Users who try using a template reference variable (e.g.,@ViewChild('myRef')) find it returnsundefinedwhen using the*cdkPortalstructural directive syntax.Additionally, the
TemplatePortalandDomPortalexamples use the legacy@ViewChilddecorator instead of signal-basedviewChildqueries.Closes #21092
What is the new behavior?
CdkPortalshould be queried by class (not template reference variable) to work with both<ng-template cdkPortal>and*cdkPortalsyntaxesviewChild(CdkPortal)TemplatePortalexample to useviewChildsignal query andinject(ViewContainerRef)DomPortalexample to useviewChildsignal queryAdditional context
The previous PR #25127 attempted to fix this by removing the
*cdkPortalsyntax from the docs entirely, but was closed. This PR takes a different approach by keeping both syntaxes and adding guidance on the correct query pattern, as suggested in the issue comments.