docs: use viewChild signal queries and modern patterns in code examples#32837
Open
yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
Open
docs: use viewChild signal queries and modern patterns in code examples#32837yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
Conversation
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
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 update.
What is the current behavior?
Several documentation files use the decorator-based
@ViewChildpattern incode examples, along with
@NgModuleproviders and constructor injection.These patterns are outdated since Angular v17+ introduced signal-based queries
and standalone components became the default.
Relates to #32709
What is the new behavior?
@ViewChildwithviewChild.required()signal queries@ViewChildrenprose references withviewChildren@NgModuleprovider blocks withbootstrapApplicationinject()AfterViewInitlifecycle withafterNextRenderFiles changed
src/cdk/a11y/a11y.md@ViewChildren->viewChildrenin prosesrc/google-maps/google-map/README.mdViewChilddecorator reference from prosesrc/google-maps/map-info-window/README.md@ViewChild->viewChild.required()in examplesrc/material/core/ripple/ripple.md@ViewChild->viewChild.required(),@NgModule->bootstrapApplication, constructor ->inject()src/material/datepicker/datepicker.md@ViewChild->viewChild.required()with generic typesrc/material/menu/menu.md@ViewChild->viewChild.required()in examplesrc/material/sidenav/sidenav.md@ViewChild->viewChild.required(),AfterViewInit->afterNextRenderAdditional context
All signal query calls use
viewChild.required()since the queried elements areexpected to always exist in the template. Signal queries return a
Signal<T>, sothe call-site invocation syntax changes from
this.foo.method()tothis.foo().method().