feat(router): Create APIs for using Router without RouterModule #47010

atscott · 2022-08-01T20:34:48Z

This commit creates and exposes the APIs required to use the Angular Router without importing RouterModule.

The newly added APIs are tree-shakable and you can add features using special functions rather than using ExtraOptions to control the providers via an internal switch in Router code.

const appRoutes: Routes = [];
bootstrapApplication(AppComponent,
  {
    providers: [
      provideRouter(appRoutes,
        withDebugTracing(),     // enables debug tracing feature
        withInMemoryScrolling() // enables scrolling feature
    ]
  }
);

This "features" pattern allows for router behavior to evolve in a backwards compatible and tree-shakable way in the future. This approach also makes features more discoverable.

The newly added APIs can be used in any application today (doesn't require an application to be bootstrapped using standalone-based APIs).

Note: APIs added in this commit are released in the "Developer Preview" mode, read more about this mode in Angular docs: https://angular.io/guide/releases#developer-preview

atscott · 2022-08-02T23:19:00Z

Open question for reviewers: When updating the tests in the router package to use the new provideRouterForTesting API, I kept using withXFeature without putting it in an array. Should we use a rest parameter for the features or should we keep it as an array in the second argument?

goldens/public-api/router/index.md

pkozlowski-opensource

Did another pass today, things looks really good so far!

I've left a couple of comments around the public API surface - I guess I'm missing important bits of context but I would like to discuss and make sure that we are on the same page.

Other than this I can see that some public API docs and usage examples are missing, so leaving a comment review for now. Will do another pass after public API surface is clarified and the docs bits are done.

goldens/public-api/router/index.md

packages/router/src/provide_router.ts

AndrewKushnir

Just publishing some comments. I will probably take care of most of them myself.

packages/router/src/provide_router.ts

packages/router/src/router_module.ts

packages/router/src/provide_router.ts

packages/router/testing/src/router_testing_module.ts

jessicajaniuk

I don't have much to say other than I really like these APIs. Well done! 👏🏻

reviewed-for: public-api, fw-core, size-tracking, integration-tests, fw-testing

brandonroberts · 2022-08-09T17:51:13Z

@atscott

I was thinking something more like

import { provideRouter } from '@angular/router';

  provideRouter([], {
    enabletTracing: true,
    preloading: true
  })

vs

import { provideRouter, withDebugTracing, withPreloading } from '@angular/router';

  provideRouter([], [
    withDebugTracing(),
    withPreloading()
  ])

Additional imports are needed also, but if it can't be tree-shaken out by the compiler, I get it.

mary-poppins · 2022-08-09T23:42:24Z

You can preview 7db44bd at https://pr47010-7db44bd.ngbuilds.io/.

mary-poppins · 2022-08-10T17:29:27Z

You can preview f8ab94e at https://pr47010-f8ab94e.ngbuilds.io/.

goldens/public-api/router/index.md

mary-poppins · 2022-08-12T00:18:13Z

You can preview a0b4a6b at https://pr47010-a0b4a6b.ngbuilds.io/.

packages/router/src/provide_router.ts

alxhub

Reviewed-for: public-api

packages/router/src/provide_router.ts

alxhub

(can't approve enough)

mary-poppins · 2022-08-12T21:50:08Z

You can preview df29701 at https://pr47010-df29701.ngbuilds.io/.

This commit creates and exposes the APIs required to use the Angular Router without importing `RouterModule`. The newly added APIs are tree-shakable and you can add features using special functions rather than using `ExtraOptions` to control the providers via an internal switch in Router code. ``` const appRoutes: Routes = []; bootstrapApplication(AppComponent, { providers: [ provideRouter(appRoutes, withDebugTracing(), // enables debug tracing feature withInMemoryScrolling() // enables scrolling feature ] } ); ``` This "features" pattern allows for router behavior to evolve in a backwards compatible and tree-shakable way in the future. This approach also makes features more discoverable. The newly added APIs can be used in any application today (doesn't require an application to be bootstrapped using standalone-based APIs). Note: APIs added in this commit are released in the "Developer Preview" mode, read more about this mode in Angular docs: https://angular.io/guide/releases#developer-preview

mary-poppins · 2022-08-12T22:19:09Z

You can preview 87b1b3e at https://pr47010-87b1b3e.ngbuilds.io/.

AndrewKushnir · 2022-08-13T02:07:24Z

Presubmit (TGP).

AndrewKushnir · 2022-08-13T05:32:44Z

FYI, TGP is "green", the PR is now ready for merge 🎉

alxhub · 2022-08-15T22:58:03Z

This PR was merged into the repository by commit 75df404.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@angular/animations](https://github.com/angular/angular) | dependencies | minor | [`14.1.3` -> `14.2.0`](https://renovatebot.com/diffs/npm/@angular%2fanimations/14.1.3/14.2.0) | | [@angular/common](https://github.com/angular/angular) | dependencies | minor | [`14.1.3` -> `14.2.0`](https://renovatebot.com/diffs/npm/@angular%2fcommon/14.1.3/14.2.0) | | [@angular/compiler](https://github.com/angular/angular) | dependencies | minor | [`14.1.3` -> `14.2.0`](https://renovatebot.com/diffs/npm/@angular%2fcompiler/14.1.3/14.2.0) | | [@angular/compiler-cli](https://github.com/angular/angular/tree/main/packages/compiler-cli) ([source](https://github.com/angular/angular)) | devDependencies | minor | [`14.1.3` -> `14.2.0`](https://renovatebot.com/diffs/npm/@angular%2fcompiler-cli/14.1.3/14.2.0) | | [@angular/core](https://github.com/angular/angular) | dependencies | minor | [`14.1.3` -> `14.2.0`](https://renovatebot.com/diffs/npm/@angular%2fcore/14.1.3/14.2.0) | | [@angular/forms](https://github.com/angular/angular) | dependencies | minor | [`14.1.3` -> `14.2.0`](https://renovatebot.com/diffs/npm/@angular%2fforms/14.1.3/14.2.0) | | [@angular/platform-browser](https://github.com/angular/angular) | dependencies | minor | [`14.1.3` -> `14.2.0`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser/14.1.3/14.2.0) | | [@angular/platform-browser-dynamic](https://github.com/angular/angular) | dependencies | minor | [`14.1.3` -> `14.2.0`](https://renovatebot.com/diffs/npm/@angular%2fplatform-browser-dynamic/14.1.3/14.2.0) | --- ### Release Notes <details> <summary>angular/angular</summary> ### [`v14.2.0`](https://github.com/angular/angular/blob/HEAD/CHANGELOG.md#1420-2022-08-25) [Compare Source](angular/angular@14.1.3...14.2.0) ##### animations | Commit | Type | Description | | -- | -- | -- | | [b96e571897](angular/angular@b96e571) | fix | fix stagger timing not handling params ([#47208](angular/angular#47208)) | ##### common | Commit | Type | Description | | -- | -- | -- | | [b380fdd59e](angular/angular@b380fdd) | feat | add a density cap for image srcsets ([#47082](angular/angular#47082)) | | [7ce497e5bc](angular/angular@7ce497e) | feat | add built-in Imgix loader ([#47082](angular/angular#47082)) | | [bff870db61](angular/angular@bff870d) | feat | add cloudflare loader ([#47082](angular/angular#47082)) | | [86e77a5d55](angular/angular@86e77a5) | feat | add Image directive skeleton ([#45627](angular/angular#45627)) ([#47082](angular/angular#47082)) | | [0566205a02](angular/angular@0566205) | feat | Add image lazy loading and fetchpriority ([#47082](angular/angular#47082)) | | [4e952ba216](angular/angular@4e952ba) | feat | add loaders for cloudinary & imagekit ([#47082](angular/angular#47082)) | | [e854a8cdde](angular/angular@e854a8c) | feat | add loading attr to NgOptimizedImage ([#47082](angular/angular#47082)) | | [8d3701cb4c](angular/angular@8d3701c) | feat | add warnings re: image distortion ([#47082](angular/angular#47082)) | | [d5f7da2120](angular/angular@d5f7da2) | feat | define public API surface for NgOptimizedImage directive ([#47082](angular/angular#47082)) | | [d3c3426aa4](angular/angular@d3c3426) | feat | detect LCP images in `NgOptimizedImage` and assert if `priority` is set ([#47082](angular/angular#47082)) | | [451b85ca17](angular/angular@451b85c) | feat | explain why width/height is required ([#47082](angular/angular#47082)) | | [586274fe65](angular/angular@586274f) | feat | provide an ability to exclude origins from preconnect checks in NgOptimizedImage ([#47082](angular/angular#47082)) | | [57f3386e5b](angular/angular@57f3386) | feat | support custom srcset attributes in NgOptimizedImage ([#47082](angular/angular#47082)) | | [7baf9a46cd](angular/angular@7baf9a4) | feat | verify that priority images have preconnect links ([#47082](angular/angular#47082)) | | [f81765b333](angular/angular@f81765b) | feat | warn if rendered size is much smaller than intrinsic ([#47082](angular/angular#47082)) | | [e2ab99b95e](angular/angular@e2ab99b) | fix | allow null/undefined to be passed to ngClass input ([#39280](angular/angular#39280)) ([#46906](angular/angular#46906)) | | [bedf537951](angular/angular@bedf537) | fix | allow null/undefined to be passed to ngStyle input ([#47069](angular/angular#47069)) | | [f9511bf6e8](angular/angular@f9511bf) | fix | avoid interacting with a destroyed injector ([#47243](angular/angular#47243)) | | [dc29e21b14](angular/angular@dc29e21) | fix | consider density descriptors with multiple digits as valid ([#47230](angular/angular#47230)) | | [801daf82d1](angular/angular@801daf8) | fix | detect `data:` and `blob:` inputs in `NgOptimizedImage` directive ([#47082](angular/angular#47082)) | | [fff8056e7f](angular/angular@fff8056) | fix | fix formatting on oversized image error ([#47188](angular/angular#47188)) ([#47232](angular/angular#47232)) | | [1ca2ce19ab](angular/angular@1ca2ce1) | fix | remove default for image width ([#47082](angular/angular#47082)) | | [c5db867ddc](angular/angular@c5db867) | fix | remove duplicate deepForEach ([#47189](angular/angular#47189)) | | [1cf43deb18](angular/angular@1cf43de) | fix | sanitize `rawSrc` and `rawSrcset` values in NgOptimizedImage directive ([#47082](angular/angular#47082)) | | [d71dfe931f](angular/angular@d71dfe9) | fix | set bound width and height onto host element ([#47082](angular/angular#47082)) | | [32caa8b669](angular/angular@32caa8b) | fix | support density descriptors with 2+ decimals ([#47197](angular/angular#47197)) ([#47232](angular/angular#47232)) | | [ae4405f0bf](angular/angular@ae4405f) | fix | throw if srcset is used with rawSrc ([#47082](angular/angular#47082)) | | [0c8eb8bc82](angular/angular@0c8eb8b) | perf | monitor LCP only for images without `priority` attribute ([#47082](angular/angular#47082)) | ##### compiler-cli | Commit | Type | Description | | -- | -- | -- | | [ea89677c12](angular/angular@ea89677) | feat | support more recent version of `tsickle` ([#47018](angular/angular#47018)) | ##### core | Commit | Type | Description | | -- | -- | -- | | [d1e83e1b30](angular/angular@d1e83e1) | feat | add `createComponent` function ([#46685](angular/angular#46685)) | | [10becab70e](angular/angular@10becab) | feat | add `reflectComponentType` function ([#46685](angular/angular#46685)) | | [4b377d3a6d](angular/angular@4b377d3) | feat | introduce createApplication API ([#46475](angular/angular#46475)) | | [31429eaccc](angular/angular@31429ea) | feat | support TypeScript 4.8 ([#47038](angular/angular#47038)) | | [796840209c](angular/angular@7968402) | fix | align TestBed interfaces and implementation ([#46635](angular/angular#46635)) | ##### forms | Commit | Type | Description | | -- | -- | -- | | [426af91a42](angular/angular@426af91) | feat | add `FormBuilder.record()` method ([#46485](angular/angular#46485)) | | [b302797de4](angular/angular@b302797) | fix | Correctly infer `FormBuilder` types involving `[value, validators]` shorthand in more cases. ([#47034](angular/angular#47034)) | ##### language-service | Commit | Type | Description | | -- | -- | -- | | [598b72bd05](angular/angular@598b72b) | feat | support fix the component missing member ([#46764](angular/angular#46764)) | ##### platform-browser | Commit | Type | Description | | -- | -- | -- | | [07606e3181](angular/angular@07606e3) | feat | add `isEmpty` method to the `TransferState` class ([#46915](angular/angular#46915)) | ##### platform-server | Commit | Type | Description | | -- | -- | -- | | [2b4d7f6733](angular/angular@2b4d7f6) | feat | support document reference in render functions ([#47032](angular/angular#47032)) | ##### router | Commit | Type | Description | | -- | -- | -- | | [0abb67af59](angular/angular@0abb67a) | feat | allow guards and resolvers to be plain functions ([#46684](angular/angular#46684)) | | [75df404467](angular/angular@75df404) | feat | Create APIs for using Router without RouterModule ([#47010](angular/angular#47010)) | | [10289f1f6e](angular/angular@10289f1) | feat | expose resolved route title ([#46826](angular/angular#46826)) | | [8600732b09](angular/angular@8600732) | feat | Expose the default matcher for `Routes` used by the `Router` ([#46913](angular/angular#46913)) | | [422323cee0](angular/angular@422323c) | feat | improve typings for RouterLink boolean inputs ([#47101](angular/angular#47101)) | | [26ea97688c](angular/angular@26ea976) | feat | Make router directives standalone ([#46758](angular/angular#46758)) | | [2a43beec15](angular/angular@2a43bee) | fix | Fix route recognition behavior with some versions of rxjs ([#47098](angular/angular#47098)) | ##### service-worker | Commit | Type | Description | | -- | -- | -- | | [383090858c](angular/angular@3830908) | feat | support `sendRequest` as a `notificationclick` action ([#46912](angular/angular#46912)) | | [3f548610dd](angular/angular@3f54861) | fix | export NoNewVersionDetectedEvent ([#47044](angular/angular#47044)) | | [482b6119c2](angular/angular@482b611) | fix | update golden `index.md` ([#47044](angular/angular#47044)) | #### Special Thanks Alex Rickabaugh, Andrew Kushnir, Andrew Scott, Bob Watson, Cédric Exbrayat, Dylan Hunn, Emmanuel Roux, FatalMerlin, George Kalpakas, Ilia Mirkin, Jan Kuehle, Jeremy Elbourn, Jessica Janiuk, JiaLiPassion, Kalbarczyk, Kara Erickson, Katie Hempenius, Kristiyan Kostadinov, Merlin, Paul Gschwendtner, Pawel Kozlowski, Tristan Sprößer, Victor Porof, angular-robot\[bot], dario-piotrowicz, ivanwonder and vyom  </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/1523 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-09-15T16:06:39Z

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.}

atscott force-pushed the standaloneRouterAPIs branch 2 times, most recently from fc15d93 to ab4fcbc Compare August 1, 2022 22:49

atscott added the area: router label Aug 1, 2022

ngbot bot added this to the Backlog milestone Aug 1, 2022

atscott force-pushed the standaloneRouterAPIs branch 3 times, most recently from f85589d to 30b165f Compare August 2, 2022 23:12

atscott added the target: minor This PR is targeted for the next minor release label Aug 2, 2022

atscott commented Aug 2, 2022

View reviewed changes

goldens/public-api/router/index.md Outdated Show resolved Hide resolved

atscott changed the title ~~Draft: Create APIs for using Router without RouterModule~~ feat(router): Create APIs for using Router without RouterModule Aug 2, 2022

atscott requested review from jelbourn, pkozlowski-opensource and AndrewKushnir August 2, 2022 23:21

atscott marked this pull request as ready for review August 2, 2022 23:21

atscott force-pushed the standaloneRouterAPIs branch 2 times, most recently from 3ea0fc3 to 80fbf37 Compare August 5, 2022 17:39

pkozlowski-opensource reviewed Aug 8, 2022

View reviewed changes

goldens/public-api/router/index.md Outdated Show resolved Hide resolved

pullapprove bot requested a review from pkozlowski-opensource August 8, 2022 15:26

pkozlowski-opensource reviewed Aug 8, 2022

View reviewed changes

goldens/public-api/router/index.md Show resolved Hide resolved

packages/router/src/provide_router.ts Show resolved Hide resolved

packages/router/src/provide_router.ts Show resolved Hide resolved

pullapprove bot requested a review from pkozlowski-opensource August 8, 2022 15:42

AndrewKushnir reviewed Aug 8, 2022

View reviewed changes

pullapprove bot requested a review from jessicajaniuk August 8, 2022 18:56

atscott force-pushed the standaloneRouterAPIs branch 4 times, most recently from 260130b to c3da7e1 Compare August 8, 2022 19:59

AndrewKushnir force-pushed the standaloneRouterAPIs branch 3 times, most recently from a739550 to 954da58 Compare August 8, 2022 22:58

jessicajaniuk approved these changes Aug 9, 2022

View reviewed changes

AndrewKushnir force-pushed the standaloneRouterAPIs branch from 7b05799 to 7db44bd Compare August 9, 2022 23:09

alxhub requested changes Aug 11, 2022

View reviewed changes

goldens/public-api/router/index.md Outdated Show resolved Hide resolved

AndrewKushnir force-pushed the standaloneRouterAPIs branch 2 times, most recently from 1694a27 to a0b4a6b Compare August 12, 2022 00:09

markostanimirovic reviewed Aug 12, 2022

View reviewed changes

packages/router/src/provide_router.ts Show resolved Hide resolved

markostanimirovic mentioned this pull request Aug 12, 2022

Effects: Introduce Standalone API for NgRx Effects ngrx/platform#3522

Closed

2 tasks

alxhub approved these changes Aug 12, 2022

View reviewed changes

packages/router/src/provide_router.ts Outdated Show resolved Hide resolved

AndrewKushnir force-pushed the standaloneRouterAPIs branch from a0b4a6b to df29701 Compare August 12, 2022 21:41

AndrewKushnir added the action: presubmit The PR is in need of a google3 presubmit label Aug 12, 2022

alxhub approved these changes Aug 12, 2022

View reviewed changes

AndrewKushnir force-pushed the standaloneRouterAPIs branch from df29701 to 87b1b3e Compare August 12, 2022 22:08

AndrewKushnir removed request for jelbourn and dylhunn August 13, 2022 02:20

AndrewKushnir added action: merge The PR is ready for merge by the caretaker and removed action: presubmit The PR is in need of a google3 presubmit labels Aug 13, 2022

alxhub closed this in 75df404 Aug 15, 2022

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(router): Create APIs for using Router without RouterModule #47010

feat(router): Create APIs for using Router without RouterModule #47010

atscott commented Aug 1, 2022 •

edited by AndrewKushnir

atscott commented Aug 2, 2022

pkozlowski-opensource left a comment

AndrewKushnir left a comment

jessicajaniuk left a comment

brandonroberts commented Aug 9, 2022

mary-poppins commented Aug 9, 2022

mary-poppins commented Aug 10, 2022

mary-poppins commented Aug 12, 2022

alxhub left a comment

alxhub left a comment

mary-poppins commented Aug 12, 2022

mary-poppins commented Aug 12, 2022

AndrewKushnir commented Aug 13, 2022

AndrewKushnir commented Aug 13, 2022

alxhub commented Aug 15, 2022

angular-automatic-lock-bot bot commented Sep 15, 2022

feat(router): Create APIs for using Router without RouterModule #47010

feat(router): Create APIs for using Router without RouterModule #47010

Conversation

atscott commented Aug 1, 2022 • edited by AndrewKushnir

atscott commented Aug 2, 2022

pkozlowski-opensource 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

brandonroberts commented Aug 9, 2022

mary-poppins commented Aug 9, 2022

mary-poppins commented Aug 10, 2022

mary-poppins commented Aug 12, 2022

alxhub left a comment

Choose a reason for hiding this comment

alxhub left a comment

Choose a reason for hiding this comment

mary-poppins commented Aug 12, 2022

mary-poppins commented Aug 12, 2022

AndrewKushnir commented Aug 13, 2022

AndrewKushnir commented Aug 13, 2022

alxhub commented Aug 15, 2022

angular-automatic-lock-bot bot commented Sep 15, 2022

atscott commented Aug 1, 2022 •

edited by AndrewKushnir