feat(core): add ability to set inputs on ComponentRef #46641

pkozlowski-opensource · 2022-06-30T13:02:53Z

This change adds the setInput method to the ComponentRef with the following benefits:

it takes input aliasing into account
it marks OnPush components as dirty
it triggers NgOnChanges lifecycle hook

mlc-mlapis · 2022-06-30T13:22:29Z

@pkozlowski-opensource Great news, thank you.

atscott

This is exciting! I think it would be worth mentioning some more about why in the commit message, not just the what. For example, how this affects testing for components with inputs, how this makes working with dynamic component creation easier (not having to manually call ngOnChanges in code, for example), and the potential for unlocking other features such as binding route params to component inputs.

packages/core/src/linker/component_factory.ts

atscott

reviewed-for: public-api, fw-core

AndrewKushnir

Looks great, just a few minor comments 👍

packages/core/src/render3/component_ref.ts

packages/core/test/render3/component_ref_spec.ts

packages/core/src/render3/component_ref.ts

jessicajaniuk

reviewed-for: fw-core, public-api

AndrewKushnir

@pkozlowski-opensource thanks for addressing the feedback. The changes look great 👍

packages/core/src/render3/component.ts

packages/core/src/linker/component_factory.ts

packages/core/src/render3/component_ref.ts

This change adds the setInput method to the ComponentRef. Previously users had to call `componentRef.instance['inputName']` to change inputs of a dynamically created component. This had several problems: * OnPush components were not marked for check and thus very difficult to test; * input aliasing was not take into account - a property name on a component could have been different from the actual input name so setting input properties was fragile; * manually setting input propertie would NOT trigger the `NgOnChanges` lifecycle hook. This modifications unifies `@Input` accross dynamically created components and the ones referenced in templates. This also opens doors to other changes: as an example router could use this new method to set `@Input`s from router params. Closes angular#12313 Closes angular#22567

AndrewKushnir

Reviewed-for: size-tracking

atscott · 2022-07-01T20:45:48Z

This PR was merged into the repository by commit 96c6139.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@angular/animations](https://github.com/angular/angular) | dependencies | minor | [`14.0.6` -> `14.1.0`](https://renovatebot.com/diffs/npm/@angular%2fanimations/14.0.6/14.1.0) | | [@angular/common](https://github.com/angular/angular) | dependencies | minor | [`14.0.6` -> `14.1.0`](https://renovatebot.com/diffs/npm/@angular%2fcommon/14.0.6/14.1.0) | | [@angular/compiler](https://github.com/angular/angular) | dependencies | minor | [`14.0.6` -> `14.1.0`](https://renovatebot.com/diffs/npm/@angular%2fcompiler/14.0.6/14.1.0) | | [@angular/compiler-cli](https://github.com/angular/angular) | devDependencies | minor | [`14.0.6` -> `14.1.0`](https://renovatebot.com/diffs/npm/@angular%2fcompiler-cli/14.0.6/14.1.0) | | [@angular/core](https://github.com/angular/angular) | dependencies | minor | [`14.0.6` -> `14.1.0`](https://renovatebot.com/diffs/npm/@angular%2fcore/14.0.6/14.1.0) | | [@angular/forms](https://github.com/angular/angular) | dependencies | minor | [`14.0.6` -> `14.1.0`](https://renovatebot.com/diffs/npm/@angular%2fforms/14.0.6/14.1.0) | | [@angular/platform-browser](https://github.com/angular/angular) | dependencies | minor | [`14.0.6` -> `14.1.0`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser/14.0.6/14.1.0) | | [@angular/platform-browser-dynamic](https://github.com/angular/angular) | dependencies | minor | [`14.0.6` -> `14.1.0`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser-dynamic/14.0.6/14.1.0) | --- ### Release Notes <details> <summary>angular/angular</summary> ### [`v14.1.0`](https://github.com/angular/angular/blob/HEAD/CHANGELOG.md#1410-2022-07-20) [Compare Source](angular/angular@14.0.7...14.1.0) #### Deprecations ##### core - The `createNgModuleRef` is deprecated in favor of newly added `createNgModule` one. - The bit field signature of `inject()` has been deprecated, in favor of the new options object. Correspondingly, `InjectFlags` is deprecated as well. ##### animations | Commit | Type | Description | | -- | -- | -- | | [55308f2df5](angular/angular@55308f2) | feat | add `provideAnimations()` and `provideNoopAnimations()` functions ([#46793](angular/angular#46793)) | ##### common | Commit | Type | Description | | -- | -- | -- | | [4a2e7335b1](angular/angular@4a2e733) | feat | make the `CommonModule` pipes standalone ([#46401](angular/angular#46401)) | | [a7597dd080](angular/angular@a7597dd) | feat | make the CommonModule directives standalone ([#46469](angular/angular#46469)) | ##### compiler | Commit | Type | Description | | -- | -- | -- | | [33ce3883a5](angular/angular@33ce388) | feat | Add extended diagnostic to warn when missing let on ngForOf ([#46683](angular/angular#46683)) | | [6f11a58040](angular/angular@6f11a58) | feat | Add extended diagnostic to warn when text attributes are intended to be bindings ([#46161](angular/angular#46161)) | | [9e836c232f](angular/angular@9e836c2) | feat | warn when style suffixes are used with attribute bindings ([#46651](angular/angular#46651)) | ##### compiler-cli | Commit | Type | Description | | -- | -- | -- | | [93c65e7b14](angular/angular@93c65e7) | feat | add extended diagnostic for non-nullable optional chains ([#46686](angular/angular#46686)) | | [131d029da1](angular/angular@131d029) | feat | detect missing control flow directive imports in standalone components ([#46146](angular/angular#46146)) | | [6b8e60c06a](angular/angular@6b8e60c) | fix | improve the missingControlFlowDirective message ([#46846](angular/angular#46846)) | ##### core | Commit | Type | Description | | -- | -- | -- | | [e8e8e5f171](angular/angular@e8e8e5f) | feat | add `createComponent` function | | [b5153814af](angular/angular@b515381) | feat | add `reflectComponentType` function | | [96c6139c9a](angular/angular@96c6139) | feat | add ability to set inputs on ComponentRef ([#46641](angular/angular#46641)) | | [a6d5fe202c](angular/angular@a6d5fe2) | feat | alias `createNgModuleRef` as `createNgModule` ([#46789](angular/angular#46789)) | | [71e606d3c3](angular/angular@71e606d) | feat | expose EnvironmentInjector on ApplicationRef ([#46665](angular/angular#46665)) | | [19e6d9ccd3](angular/angular@19e6d9c) | feat | import AsyncStackTaggingZone if available ([#46693](angular/angular#46693)) | | [a7a14df5f8](angular/angular@a7a14df) | feat | introduce `EnvironmentInjector.runInContext` API ([#46653](angular/angular#46653)) | | [fa52b6e906](angular/angular@fa52b6e) | feat | options object to supersede bit flags for `inject()` ([#46649](angular/angular#46649)) | | [af20112222](angular/angular@af20112) | feat | support the descendants option for ContentChild queries ([#46638](angular/angular#46638)) | | [945a3ad359](angular/angular@945a3ad) | fix | Fix `runInContext` for `NgModuleRef` injector ([#46877](angular/angular#46877)) | | [bb7c80477b](angular/angular@bb7c804) | fix | make parent injector argument required in `createEnvironmentInjector` ([#46397](angular/angular#46397)) | ##### http | Commit | Type | Description | | -- | -- | -- | | [82acbf919b](angular/angular@82acbf9) | feat | improve error message for nullish header ([#46059](angular/angular#46059)) | ##### router | Commit | Type | Description | | -- | -- | -- | | [53ca936366](angular/angular@53ca936) | feat | Add ability to create `UrlTree` from any `ActivatedRouteSnapshot` ([#45877](angular/angular#45877)) | | [de058bba99](angular/angular@de058bb) | feat | Add CanMatch guard to control whether a Route should match ([#46021](angular/angular#46021)) | | [6c1357dd7d](angular/angular@6c1357d) | feat | Add stable cancelation code to `NavigationCancel` event ([#46675](angular/angular#46675)) | | [a4ce273e50](angular/angular@a4ce273) | feat | Add the target `RouterStateSnapshot` to `NavigationError` ([#46731](angular/angular#46731)) | | [abe3759e24](angular/angular@abe3759) | fix | allow to return `UrlTree` from `CanMatchFn` ([#46455](angular/angular#46455)) | | [e8c7dd10e9](angular/angular@e8c7dd1) | fix | Ensure `APP_INITIALIZER` of `enabledBlocking` option completes ([#46026](angular/angular#46026)) | | [ce20ed067f](angular/angular@ce20ed0) | fix | Ensure Route injector is created before running CanMatch guards ([#46394](angular/angular#46394)) | | [6a7b818d94](angular/angular@6a7b818) | fix | Ensure target `RouterStateSnapshot` is defined in `NavigationError` ([#46842](angular/angular#46842)) | | [f94c6f433d](angular/angular@f94c6f4) | fix | Expose CanMatchFn as public API ([#46394](angular/angular#46394)) | | [e8ae0fe3e9](angular/angular@e8ae0fe) | fix | Fix cancellation code for canLoad rejections ([#46752](angular/angular#46752)) | ##### upgrade | Commit | Type | Description | | -- | -- | -- | | [e9cb0454dc](angular/angular@e9cb045) | feat | more closely align `UpgradeModule#bootstrap()` with `angular.bootstrap()` ([#46214](angular/angular#46214)) | #### Special Thanks AleksanderBodurri, Alex Rickabaugh, Andrew Kushnir, Andrew Scott, Cédric Exbrayat, Dmitrij Kuba, Dylan Hunn, George Kalpakas, Jessica Janiuk, JiaLiPassion, Joey Perrott, John Vandenberg, JoostK, Keith Li, Or'el Ben-Ya'ir, Paul Gschwendtner, Pawel Kozlowski, SyedAhm3r, arturovt, mariu, markostanimirovic and mgechev  ### [`v14.0.7`](https://github.com/angular/angular/blob/HEAD/CHANGELOG.md#1407-2022-07-20) [Compare Source](angular/angular@14.0.6...14.0.7) ##### animations | Commit | Type | Description | | -- | -- | -- | | [5bdbb6285b](angular/angular@5bdbb62) | fix | make sure falsy values are added to \_globalTimelineStyles ([#46863](angular/angular#46863)) | ##### compiler | Commit | Type | Description | | -- | -- | -- | | [41253f9c46](angular/angular@41253f9) | fix | inputs/outputs incorrectly parsed in jit mode ([#46813](angular/angular#46813)) | ##### core | Commit | Type | Description | | -- | -- | -- | | [4e77c7fbf3](angular/angular@4e77c7f) | fix | do not invoke jasmine `done` callback multiple times with `waitForAsync` | #### Special Thanks Andrew Kushnir, Andrew Scott, Bob Watson, Cédric Exbrayat, Doug Parker, George Kalpakas, Jessica Janiuk, Kristiyan Kostadinov, Paul Gschwendtner, acvi, dario-piotrowicz, jnizet and piyush132000  </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1472 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

angular-automatic-lock-bot · 2022-08-01T16:06:56Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

pkozlowski-opensource force-pushed the fixit_set_input branch from 948c4ad to 7019681 Compare June 30, 2022 13:29

pkozlowski-opensource added action: review The PR is still awaiting reviews from at least one requested reviewer area: core Issues related to the framework runtime labels Jun 30, 2022

ngbot bot added this to the Backlog milestone Jun 30, 2022

pkozlowski-opensource modified the milestones: Backlog, Fixit H1'2022 Jun 30, 2022

pkozlowski-opensource added the target: minor This PR is targeted for the next minor release label Jun 30, 2022

pkozlowski-opensource marked this pull request as ready for review June 30, 2022 13:53

pullapprove bot requested review from alxhub, AndrewKushnir and jessicajaniuk June 30, 2022 13:53

atscott reviewed Jun 30, 2022

View reviewed changes

packages/core/src/linker/component_factory.ts Outdated Show resolved Hide resolved

pkozlowski-opensource force-pushed the fixit_set_input branch from 7019681 to 47c4358 Compare June 30, 2022 16:28

alxhub approved these changes Jun 30, 2022

View reviewed changes

pullapprove bot requested a review from alxhub June 30, 2022 17:47

atscott approved these changes Jun 30, 2022

View reviewed changes

AndrewKushnir reviewed Jun 30, 2022

View reviewed changes

packages/core/src/render3/component_ref.ts Outdated Show resolved Hide resolved

packages/core/test/render3/component_ref_spec.ts Show resolved Hide resolved

packages/core/src/render3/component_ref.ts Outdated Show resolved Hide resolved

pullapprove bot requested review from AndrewKushnir June 30, 2022 18:13

jessicajaniuk approved these changes Jun 30, 2022

View reviewed changes

jessicajaniuk removed the request for review from alxhub June 30, 2022 22:16

pkozlowski-opensource force-pushed the fixit_set_input branch 3 times, most recently from 39ef803 to 7363c73 Compare July 1, 2022 10:24

AndrewKushnir approved these changes Jul 1, 2022

View reviewed changes

packages/core/src/render3/component.ts Outdated Show resolved Hide resolved

packages/core/src/linker/component_factory.ts Show resolved Hide resolved

packages/core/src/render3/component_ref.ts Show resolved Hide resolved

pkozlowski-opensource force-pushed the fixit_set_input branch from 7363c73 to f02ca24 Compare July 1, 2022 18:39

pkozlowski-opensource added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Jul 1, 2022

AndrewKushnir approved these changes Jul 1, 2022

View reviewed changes

pkozlowski-opensource force-pushed the fixit_set_input branch from f02ca24 to 982f88a Compare July 1, 2022 18:57

pullapprove bot requested review from AndrewKushnir and jessicajaniuk July 1, 2022 18:57

AndrewKushnir approved these changes Jul 1, 2022

View reviewed changes

pullapprove bot requested a review from AndrewKushnir July 1, 2022 18:58

AndrewKushnir approved these changes Jul 1, 2022

View reviewed changes

AndrewKushnir removed the request for review from jessicajaniuk July 1, 2022 18:59

atscott closed this in 96c6139 Jul 1, 2022

demike mentioned this pull request Jul 4, 2022

Alternative way for depreciation of ComponentFactory in order to get componentFactory inputs #44926

Closed

This was referenced Jul 4, 2022

ComponentRef Change detector doesn't trigger detecting for view #36667

Closed

Dynamic component detectChanges trigger ngDoCheck but not refresh view #39524

Closed

There is no way to access inputs or outputs of Components created by NgComponentOutlet #15360

Open

tiberiuzuld mentioned this pull request Jul 21, 2022

Angular 14.1.0 issue with implementing ComponentRef Indigosoft/ngxd#48

Closed

angular-automatic-lock-bot bot locked and limited conversation to collaborators Aug 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): add ability to set inputs on ComponentRef #46641

feat(core): add ability to set inputs on ComponentRef #46641

pkozlowski-opensource commented Jun 30, 2022 •

edited

mlc-mlapis commented Jun 30, 2022

atscott left a comment

atscott left a comment

AndrewKushnir left a comment

jessicajaniuk left a comment

AndrewKushnir left a comment

AndrewKushnir left a comment

atscott commented Jul 1, 2022

angular-automatic-lock-bot bot commented Aug 1, 2022

feat(core): add ability to set inputs on ComponentRef #46641

feat(core): add ability to set inputs on ComponentRef #46641

Conversation

pkozlowski-opensource commented Jun 30, 2022 • edited

mlc-mlapis commented Jun 30, 2022

atscott left a comment

Choose a reason for hiding this comment

atscott left a comment

Choose a reason for hiding this comment

AndrewKushnir left a comment

Choose a reason for hiding this comment

jessicajaniuk left a comment

Choose a reason for hiding this comment

AndrewKushnir left a comment

Choose a reason for hiding this comment

AndrewKushnir left a comment

Choose a reason for hiding this comment

atscott commented Jul 1, 2022

angular-automatic-lock-bot bot commented Aug 1, 2022

pkozlowski-opensource commented Jun 30, 2022 •

edited