docs(cdk): use inject() and remove unnecessary module references#32830
Open
yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
Open
docs(cdk): use inject() and remove unnecessary module references#32830yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
yogeshwaran-c wants to merge 1 commit intoangular:mainfrom
Conversation
Update CDK documentation to use the inject() function instead of constructor injection, and remove misleading module import requirements for services that are providedIn: 'root' (LiveAnnouncer, Clipboard, MediaMatcher, BreakpointObserver). Also replace A11yModule references with direct directive import guidance for CdkTrapFocus.
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?
Several CDK documentation files use constructor-based dependency injection and reference legacy module imports:
a11y.mdandfocus-trap.mdsayCdkTrapFocusis "declared inA11yModule", but the directive can be imported directlylive-announcer.mdlistsLiveAnnouncerin componentprovidersdespite it beingprovidedIn: 'root'clipboard.mduses constructor injection for theClipboardservicemedia-matcher.mdandbreakpoints-observer.mdsay to includeLayoutModule, butMediaMatcherandBreakpointObserverare bothprovidedIn: 'root'inject()Part of #32709
What is the new behavior?
A11yModule" with "ImportCdkTrapFocusin your component"providers: [LiveAnnouncer]and module import guidanceinject()functionBreakpointsModuleheading typo (should beBreakpointObserver)Files changed
src/cdk/a11y/a11y.md- FocusTrap import guidance, LiveAnnouncer inject()src/cdk/a11y/focus-trap/focus-trap.md- CdkTrapFocus import guidancesrc/cdk/a11y/live-announcer/live-announcer.md- Remove unnecessary providers, inject()src/cdk/clipboard/clipboard.md- Clipboard inject()src/cdk/layout/breakpoints-observer.md- Fix heading, remove LayoutModule ref, inject()src/cdk/layout/layout.md- MediaMatcher inject()src/cdk/layout/media-matcher.md- Remove LayoutModule ref, inject()