@angular/router 16.1.0-rc.0 → 16.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm2022/src/components/empty_outlet.mjs +3 -3
- package/esm2022/src/directives/router_link.mjs +19 -19
- package/esm2022/src/directives/router_link_active.mjs +3 -3
- package/esm2022/src/directives/router_outlet.mjs +9 -9
- package/esm2022/src/events.mjs +26 -26
- package/esm2022/src/models.mjs +1 -1
- package/esm2022/src/navigation_transition.mjs +4 -4
- package/esm2022/src/page_title_strategy.mjs +6 -6
- package/esm2022/src/provide_router.mjs +15 -15
- package/esm2022/src/route_reuse_strategy.mjs +6 -6
- package/esm2022/src/router.mjs +19 -19
- package/esm2022/src/router_config.mjs +1 -1
- package/esm2022/src/router_config_loader.mjs +3 -3
- package/esm2022/src/router_module.mjs +4 -4
- package/esm2022/src/router_outlet_context.mjs +3 -3
- package/esm2022/src/router_preloader.mjs +9 -9
- package/esm2022/src/router_scroller.mjs +3 -3
- package/esm2022/src/router_state.mjs +2 -2
- package/esm2022/src/shared.mjs +3 -3
- package/esm2022/src/url_handling_strategy.mjs +6 -6
- package/esm2022/src/url_tree.mjs +3 -3
- package/esm2022/src/utils/functional_guards.mjs +6 -6
- package/esm2022/src/version.mjs +1 -1
- package/esm2022/testing/src/router_testing_harness.mjs +6 -6
- package/esm2022/testing/src/router_testing_module.mjs +4 -4
- package/esm2022/upgrade/src/upgrade.mjs +3 -3
- package/fesm2022/router.mjs +145 -145
- package/fesm2022/router.mjs.map +1 -1
- package/fesm2022/testing.mjs +11 -11
- package/fesm2022/upgrade.mjs +3 -3
- package/fesm2022/upgrade.mjs.map +1 -1
- package/index.d.ts +180 -180
- package/package.json +4 -4
- package/testing/index.d.ts +1 -1
- package/upgrade/index.d.ts +3 -3
package/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @license Angular v16.1.
|
|
2
|
+
* @license Angular v16.1.1
|
|
3
3
|
* (c) 2010-2022 Google LLC. https://angular.io/
|
|
4
4
|
* License: MIT
|
|
5
5
|
*/
|
|
@@ -174,8 +174,8 @@ export declare class ActivatedRouteSnapshot {
|
|
|
174
174
|
/**
|
|
175
175
|
* An event triggered at the end of the activation part
|
|
176
176
|
* of the Resolve phase of routing.
|
|
177
|
-
* @see
|
|
178
|
-
* @see
|
|
177
|
+
* @see {@link ActivationStart}
|
|
178
|
+
* @see {@link ResolveStart}
|
|
179
179
|
*
|
|
180
180
|
* @publicApi
|
|
181
181
|
*/
|
|
@@ -192,8 +192,8 @@ export declare class ActivationEnd {
|
|
|
192
192
|
/**
|
|
193
193
|
* An event triggered at the start of the activation part
|
|
194
194
|
* of the Resolve phase of routing.
|
|
195
|
-
* @see
|
|
196
|
-
* @see
|
|
195
|
+
* @see {@link ActivationEnd}
|
|
196
|
+
* @see {@link ResolveStart}
|
|
197
197
|
*
|
|
198
198
|
* @publicApi
|
|
199
199
|
*/
|
|
@@ -301,7 +301,7 @@ export declare abstract class BaseRouteReuseStrategy implements RouteReuseStrate
|
|
|
301
301
|
* @deprecated Class-based `Route` guards are deprecated in favor of functional guards. An
|
|
302
302
|
* injectable class can be used as a functional guard using the `inject` function:
|
|
303
303
|
* `canActivate: [() => inject(myGuard).canActivate()]`.
|
|
304
|
-
* @see
|
|
304
|
+
* @see {@link CanActivateFn}
|
|
305
305
|
*/
|
|
306
306
|
export declare interface CanActivate {
|
|
307
307
|
canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
|
|
@@ -367,7 +367,7 @@ export declare interface CanActivate {
|
|
|
367
367
|
* @deprecated Class-based `Route` guards are deprecated in favor of functional guards. An
|
|
368
368
|
* injectable class can be used as a functional guard using the `inject` function:
|
|
369
369
|
* `canActivateChild: [() => inject(myGuard).canActivateChild()]`.
|
|
370
|
-
* @see
|
|
370
|
+
* @see {@link CanActivateChildFn}
|
|
371
371
|
*/
|
|
372
372
|
export declare interface CanActivateChild {
|
|
373
373
|
canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
|
|
@@ -386,7 +386,7 @@ export declare interface CanActivateChild {
|
|
|
386
386
|
* {@example router/route_functional_guards.ts region="CanActivateChildFn"}
|
|
387
387
|
*
|
|
388
388
|
* @publicApi
|
|
389
|
-
* @see
|
|
389
|
+
* @see {@link Route}
|
|
390
390
|
*/
|
|
391
391
|
export declare type CanActivateChildFn = (childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot) => Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
|
|
392
392
|
|
|
@@ -408,7 +408,7 @@ export declare type CanActivateChildFn = (childRoute: ActivatedRouteSnapshot, st
|
|
|
408
408
|
* {@example router/route_functional_guards.ts region="CanActivateFnInRoute"}
|
|
409
409
|
*
|
|
410
410
|
* @publicApi
|
|
411
|
-
* @see
|
|
411
|
+
* @see {@link Route}
|
|
412
412
|
*/
|
|
413
413
|
export declare type CanActivateFn = (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
|
|
414
414
|
|
|
@@ -470,7 +470,7 @@ export declare type CanActivateFn = (route: ActivatedRouteSnapshot, state: Route
|
|
|
470
470
|
* @deprecated Class-based `Route` guards are deprecated in favor of functional guards. An
|
|
471
471
|
* injectable class can be used as a functional guard using the `inject` function:
|
|
472
472
|
* `canDeactivate: [() => inject(myGuard).canDeactivate()]`.
|
|
473
|
-
* @see
|
|
473
|
+
* @see {@link CanDeactivateFn}
|
|
474
474
|
*/
|
|
475
475
|
export declare interface CanDeactivate<T> {
|
|
476
476
|
canDeactivate(component: T, currentRoute: ActivatedRouteSnapshot, currentState: RouterStateSnapshot, nextState: RouterStateSnapshot): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
|
|
@@ -489,7 +489,7 @@ export declare interface CanDeactivate<T> {
|
|
|
489
489
|
* {@example router/route_functional_guards.ts region="CanDeactivateFn"}
|
|
490
490
|
*
|
|
491
491
|
* @publicApi
|
|
492
|
-
* @see
|
|
492
|
+
* @see {@link Route}
|
|
493
493
|
*/
|
|
494
494
|
export declare type CanDeactivateFn<T> = (component: T, currentRoute: ActivatedRouteSnapshot, currentState: RouterStateSnapshot, nextState: RouterStateSnapshot) => Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
|
|
495
495
|
|
|
@@ -555,9 +555,9 @@ export declare interface CanLoad {
|
|
|
555
555
|
* The signature of a function used as a `canLoad` guard on a `Route`.
|
|
556
556
|
*
|
|
557
557
|
* @publicApi
|
|
558
|
-
* @see
|
|
559
|
-
* @see
|
|
560
|
-
* @see
|
|
558
|
+
* @see {@link CanLoad}
|
|
559
|
+
* @see {@link Route}
|
|
560
|
+
* @see {@link CanMatchFn}
|
|
561
561
|
* @deprecated Use `Route.canMatch` and `CanMatchFn` instead
|
|
562
562
|
*/
|
|
563
563
|
export declare type CanLoadFn = (route: Route, segments: UrlSegment[]) => Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
|
|
@@ -625,7 +625,7 @@ export declare type CanLoadFn = (route: Route, segments: UrlSegment[]) => Observ
|
|
|
625
625
|
* @deprecated Class-based `Route` guards are deprecated in favor of functional guards. An
|
|
626
626
|
* injectable class can be used as a functional guard using the `inject` function:
|
|
627
627
|
* `canMatch: [() => inject(myGuard).canMatch()]`.
|
|
628
|
-
* @see
|
|
628
|
+
* @see {@link CanMatchFn}
|
|
629
629
|
*/
|
|
630
630
|
export declare interface CanMatch {
|
|
631
631
|
canMatch(route: Route, segments: UrlSegment[]): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
|
|
@@ -644,15 +644,15 @@ export declare interface CanMatch {
|
|
|
644
644
|
* {@example router/route_functional_guards.ts region="CanMatchFn"}
|
|
645
645
|
*
|
|
646
646
|
* @publicApi
|
|
647
|
-
* @see
|
|
647
|
+
* @see {@link Route}
|
|
648
648
|
*/
|
|
649
649
|
export declare type CanMatchFn = (route: Route, segments: UrlSegment[]) => Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
|
|
650
650
|
|
|
651
651
|
/**
|
|
652
652
|
* An event triggered at the end of the child-activation part
|
|
653
653
|
* of the Resolve phase of routing.
|
|
654
|
-
* @see
|
|
655
|
-
* @see
|
|
654
|
+
* @see {@link ChildActivationStart}
|
|
655
|
+
* @see {@link ResolveStart}
|
|
656
656
|
* @publicApi
|
|
657
657
|
*/
|
|
658
658
|
export declare class ChildActivationEnd {
|
|
@@ -668,8 +668,8 @@ export declare class ChildActivationEnd {
|
|
|
668
668
|
/**
|
|
669
669
|
* An event triggered at the start of the child-activation
|
|
670
670
|
* part of the Resolve phase of routing.
|
|
671
|
-
* @see
|
|
672
|
-
* @see
|
|
671
|
+
* @see {@link ChildActivationEnd}
|
|
672
|
+
* @see {@link ResolveStart}
|
|
673
673
|
*
|
|
674
674
|
* @publicApi
|
|
675
675
|
*/
|
|
@@ -713,8 +713,8 @@ export declare class ChildrenOutletContexts {
|
|
|
713
713
|
/**
|
|
714
714
|
* A type alias for providers returned by `withComponentInputBinding` for use with `provideRouter`.
|
|
715
715
|
*
|
|
716
|
-
* @see
|
|
717
|
-
* @see
|
|
716
|
+
* @see {@link withComponentInputBinding}
|
|
717
|
+
* @see {@link provideRouter}
|
|
718
718
|
*
|
|
719
719
|
* @publicApi
|
|
720
720
|
*/
|
|
@@ -786,7 +786,7 @@ export declare function createUrlTreeFromSnapshot(relativeTo: ActivatedRouteSnap
|
|
|
786
786
|
*
|
|
787
787
|
* Represents static data associated with a particular route.
|
|
788
788
|
*
|
|
789
|
-
* @see
|
|
789
|
+
* @see {@link Route#data}
|
|
790
790
|
*
|
|
791
791
|
* @publicApi
|
|
792
792
|
*/
|
|
@@ -797,8 +797,8 @@ export declare type Data = {
|
|
|
797
797
|
/**
|
|
798
798
|
* A type alias for providers returned by `withDebugTracing` for use with `provideRouter`.
|
|
799
799
|
*
|
|
800
|
-
* @see
|
|
801
|
-
* @see
|
|
800
|
+
* @see {@link withDebugTracing}
|
|
801
|
+
* @see {@link provideRouter}
|
|
802
802
|
*
|
|
803
803
|
* @publicApi
|
|
804
804
|
*/
|
|
@@ -807,8 +807,8 @@ export declare type DebugTracingFeature = RouterFeature<RouterFeatureKind.DebugT
|
|
|
807
807
|
/**
|
|
808
808
|
* An ES Module object with a default export of the given type.
|
|
809
809
|
*
|
|
810
|
-
* @see
|
|
811
|
-
* @see
|
|
810
|
+
* @see {@link Route#loadComponent}
|
|
811
|
+
* @see {@link LoadChildrenCallback}
|
|
812
812
|
*
|
|
813
813
|
* @publicApi
|
|
814
814
|
*/
|
|
@@ -845,8 +845,8 @@ export declare class DefaultTitleStrategy extends TitleStrategy {
|
|
|
845
845
|
* @param segmentGroup The current segment group being matched
|
|
846
846
|
* @param route The `Route` to match against.
|
|
847
847
|
*
|
|
848
|
-
* @see UrlMatchResult
|
|
849
|
-
* @see Route
|
|
848
|
+
* @see {@link UrlMatchResult}
|
|
849
|
+
* @see {@link Route}
|
|
850
850
|
*
|
|
851
851
|
* @returns The resulting match information or `null` if the `route` should not match.
|
|
852
852
|
* @publicApi
|
|
@@ -885,13 +885,13 @@ export declare class DefaultUrlSerializer implements UrlSerializer {
|
|
|
885
885
|
* using `inject`: `canActivate: [() => inject(myGuard).canActivate()]`.
|
|
886
886
|
*
|
|
887
887
|
* @deprecated
|
|
888
|
-
* @see
|
|
889
|
-
* @see
|
|
890
|
-
* @see
|
|
891
|
-
* @see
|
|
892
|
-
* @see
|
|
893
|
-
* @see
|
|
894
|
-
* @see
|
|
888
|
+
* @see {@link CanMatchFn}
|
|
889
|
+
* @see {@link CanLoadFn}
|
|
890
|
+
* @see {@link CanActivateFn}
|
|
891
|
+
* @see {@link CanActivateChildFn}
|
|
892
|
+
* @see {@link CanDeactivateFn}
|
|
893
|
+
* @see {@link ResolveFn}
|
|
894
|
+
* @see {@link core/inject}
|
|
895
895
|
* @publicApi
|
|
896
896
|
*/
|
|
897
897
|
export declare type DeprecatedGuard = ProviderToken<any> | any;
|
|
@@ -912,8 +912,8 @@ export declare type DetachedRouteHandle = {};
|
|
|
912
912
|
* A type alias for providers returned by `withDisabledInitialNavigation` for use with
|
|
913
913
|
* `provideRouter`.
|
|
914
914
|
*
|
|
915
|
-
* @see
|
|
916
|
-
* @see
|
|
915
|
+
* @see {@link withDisabledInitialNavigation}
|
|
916
|
+
* @see {@link provideRouter}
|
|
917
917
|
*
|
|
918
918
|
* @publicApi
|
|
919
919
|
*/
|
|
@@ -923,8 +923,8 @@ export declare type DisabledInitialNavigationFeature = RouterFeature<RouterFeatu
|
|
|
923
923
|
* A type alias for providers returned by `withEnabledBlockingInitialNavigation` for use with
|
|
924
924
|
* `provideRouter`.
|
|
925
925
|
*
|
|
926
|
-
* @see
|
|
927
|
-
* @see
|
|
926
|
+
* @see {@link withEnabledBlockingInitialNavigation}
|
|
927
|
+
* @see {@link provideRouter}
|
|
928
928
|
*
|
|
929
929
|
* @publicApi
|
|
930
930
|
*/
|
|
@@ -995,7 +995,7 @@ export declare const enum EventType {
|
|
|
995
995
|
* A set of configuration options for a router module, provided in the
|
|
996
996
|
* `forRoot()` method.
|
|
997
997
|
*
|
|
998
|
-
* @see
|
|
998
|
+
* @see {@link forRoot()}
|
|
999
999
|
*
|
|
1000
1000
|
*
|
|
1001
1001
|
* @publicApi
|
|
@@ -1068,7 +1068,7 @@ export declare interface ExtraOptions extends InMemoryScrollingOptions, RouterCo
|
|
|
1068
1068
|
/**
|
|
1069
1069
|
* An event triggered at the end of the Guard phase of routing.
|
|
1070
1070
|
*
|
|
1071
|
-
* @see
|
|
1071
|
+
* @see {@link GuardsCheckStart}
|
|
1072
1072
|
*
|
|
1073
1073
|
* @publicApi
|
|
1074
1074
|
*/
|
|
@@ -1097,7 +1097,7 @@ export declare class GuardsCheckEnd extends RouterEvent {
|
|
|
1097
1097
|
/**
|
|
1098
1098
|
* An event triggered at the start of the Guard phase of routing.
|
|
1099
1099
|
*
|
|
1100
|
-
* @see
|
|
1100
|
+
* @see {@link GuardsCheckEnd}
|
|
1101
1101
|
*
|
|
1102
1102
|
* @publicApi
|
|
1103
1103
|
*/
|
|
@@ -1163,7 +1163,7 @@ declare namespace i4 {
|
|
|
1163
1163
|
* more control over when the router starts its initial navigation due to some complex
|
|
1164
1164
|
* initialization logic.
|
|
1165
1165
|
*
|
|
1166
|
-
* @see
|
|
1166
|
+
* @see {@link forRoot()}
|
|
1167
1167
|
*
|
|
1168
1168
|
* @publicApi
|
|
1169
1169
|
*/
|
|
@@ -1173,9 +1173,9 @@ export declare type InitialNavigation = 'disabled' | 'enabledBlocking' | 'enable
|
|
|
1173
1173
|
* A type alias for providers returned by `withEnabledBlockingInitialNavigation` or
|
|
1174
1174
|
* `withDisabledInitialNavigation` functions for use with `provideRouter`.
|
|
1175
1175
|
*
|
|
1176
|
-
* @see
|
|
1177
|
-
* @see
|
|
1178
|
-
* @see
|
|
1176
|
+
* @see {@link withEnabledBlockingInitialNavigation}
|
|
1177
|
+
* @see {@link withDisabledInitialNavigation}
|
|
1178
|
+
* @see {@link provideRouter}
|
|
1179
1179
|
*
|
|
1180
1180
|
* @publicApi
|
|
1181
1181
|
*/
|
|
@@ -1184,8 +1184,8 @@ export declare type InitialNavigationFeature = EnabledBlockingInitialNavigationF
|
|
|
1184
1184
|
/**
|
|
1185
1185
|
* A type alias for providers returned by `withInMemoryScrolling` for use with `provideRouter`.
|
|
1186
1186
|
*
|
|
1187
|
-
* @see
|
|
1188
|
-
* @see
|
|
1187
|
+
* @see {@link withInMemoryScrolling}
|
|
1188
|
+
* @see {@link provideRouter}
|
|
1189
1189
|
*
|
|
1190
1190
|
* @publicApi
|
|
1191
1191
|
*/
|
|
@@ -1297,7 +1297,7 @@ export declare interface IsActiveMatchOptions {
|
|
|
1297
1297
|
*
|
|
1298
1298
|
* A function that returns a set of routes to load.
|
|
1299
1299
|
*
|
|
1300
|
-
* @see
|
|
1300
|
+
* @see {@link LoadChildrenCallback}
|
|
1301
1301
|
* @publicApi
|
|
1302
1302
|
*/
|
|
1303
1303
|
export declare type LoadChildren = LoadChildrenCallback;
|
|
@@ -1334,7 +1334,7 @@ export declare type LoadChildren = LoadChildrenCallback;
|
|
|
1334
1334
|
* }];
|
|
1335
1335
|
* ```
|
|
1336
1336
|
*
|
|
1337
|
-
* @see
|
|
1337
|
+
* @see {@link Route#loadChildren}
|
|
1338
1338
|
* @publicApi
|
|
1339
1339
|
*/
|
|
1340
1340
|
export declare type LoadChildrenCallback = () => Type<any> | NgModuleFactory<any> | Routes | Observable<Type<any> | Routes | DefaultExport<Type<any>> | DefaultExport<Routes>> | Promise<NgModuleFactory<any> | Type<any> | Routes | DefaultExport<Type<any>> | DefaultExport<Routes>>;
|
|
@@ -1351,7 +1351,7 @@ declare interface LoadedRouterConfig {
|
|
|
1351
1351
|
* Usage {@example router/utils/functional_guards.ts region='CanActivate'}
|
|
1352
1352
|
*
|
|
1353
1353
|
* @publicApi
|
|
1354
|
-
* @see Route
|
|
1354
|
+
* @see {@link Route}
|
|
1355
1355
|
*/
|
|
1356
1356
|
export declare function mapToCanActivate(providers: Array<Type<{
|
|
1357
1357
|
canActivate: CanActivateFn;
|
|
@@ -1364,7 +1364,7 @@ export declare function mapToCanActivate(providers: Array<Type<{
|
|
|
1364
1364
|
* Usage {@example router/utils/functional_guards.ts region='CanActivate'}
|
|
1365
1365
|
*
|
|
1366
1366
|
* @publicApi
|
|
1367
|
-
* @see Route
|
|
1367
|
+
* @see {@link Route}
|
|
1368
1368
|
*/
|
|
1369
1369
|
export declare function mapToCanActivateChild(providers: Array<Type<{
|
|
1370
1370
|
canActivateChild: CanActivateChildFn;
|
|
@@ -1377,7 +1377,7 @@ export declare function mapToCanActivateChild(providers: Array<Type<{
|
|
|
1377
1377
|
* Usage {@example router/utils/functional_guards.ts region='CanActivate'}
|
|
1378
1378
|
*
|
|
1379
1379
|
* @publicApi
|
|
1380
|
-
* @see Route
|
|
1380
|
+
* @see {@link Route}
|
|
1381
1381
|
*/
|
|
1382
1382
|
export declare function mapToCanDeactivate<T = unknown>(providers: Array<Type<{
|
|
1383
1383
|
canDeactivate: CanDeactivateFn<T>;
|
|
@@ -1390,7 +1390,7 @@ export declare function mapToCanDeactivate<T = unknown>(providers: Array<Type<{
|
|
|
1390
1390
|
* Usage {@example router/utils/functional_guards.ts region='CanActivate'}
|
|
1391
1391
|
*
|
|
1392
1392
|
* @publicApi
|
|
1393
|
-
* @see Route
|
|
1393
|
+
* @see {@link Route}
|
|
1394
1394
|
*/
|
|
1395
1395
|
export declare function mapToCanMatch(providers: Array<Type<{
|
|
1396
1396
|
canMatch: CanMatchFn;
|
|
@@ -1403,7 +1403,7 @@ export declare function mapToCanMatch(providers: Array<Type<{
|
|
|
1403
1403
|
* Usage {@example router/utils/functional_guards.ts region='Resolve'}
|
|
1404
1404
|
*
|
|
1405
1405
|
* @publicApi
|
|
1406
|
-
* @see Route
|
|
1406
|
+
* @see {@link Route}
|
|
1407
1407
|
*/
|
|
1408
1408
|
export declare function mapToResolve<T>(provider: Type<{
|
|
1409
1409
|
resolve: ResolveFn<T>;
|
|
@@ -1481,8 +1481,8 @@ export declare interface Navigation {
|
|
|
1481
1481
|
* Supply an object containing any of these properties to a `Router` navigation function to
|
|
1482
1482
|
* control how the navigation should be handled.
|
|
1483
1483
|
*
|
|
1484
|
-
* @see
|
|
1485
|
-
* @see
|
|
1484
|
+
* @see {@link Router#navigate}
|
|
1485
|
+
* @see {@link Router#navigateByUrl}
|
|
1486
1486
|
* @see [Routing and Navigation guide](guide/router)
|
|
1487
1487
|
*
|
|
1488
1488
|
* @publicApi
|
|
@@ -1494,8 +1494,8 @@ export declare interface NavigationBehaviorOptions {
|
|
|
1494
1494
|
* This value is a subset of the options available in `OnSameUrlNavigation` and
|
|
1495
1495
|
* will take precedence over the default value set for the `Router`.
|
|
1496
1496
|
*
|
|
1497
|
-
* @see
|
|
1498
|
-
* @see
|
|
1497
|
+
* @see {@link OnSameUrlNavigation}
|
|
1498
|
+
* @see {@link RouterConfigOptions}
|
|
1499
1499
|
*/
|
|
1500
1500
|
onSameUrlNavigation?: Extract<OnSameUrlNavigation, 'reload'>;
|
|
1501
1501
|
/**
|
|
@@ -1541,9 +1541,9 @@ export declare interface NavigationBehaviorOptions {
|
|
|
1541
1541
|
* This can happen for several reasons including when a route guard
|
|
1542
1542
|
* returns `false` or initiates a redirect by returning a `UrlTree`.
|
|
1543
1543
|
*
|
|
1544
|
-
* @see
|
|
1545
|
-
* @see
|
|
1546
|
-
* @see
|
|
1544
|
+
* @see {@link NavigationStart}
|
|
1545
|
+
* @see {@link NavigationEnd}
|
|
1546
|
+
* @see {@link NavigationError}
|
|
1547
1547
|
*
|
|
1548
1548
|
* @publicApi
|
|
1549
1549
|
*/
|
|
@@ -1608,9 +1608,9 @@ export declare const enum NavigationCancellationCode {
|
|
|
1608
1608
|
/**
|
|
1609
1609
|
* An event triggered when a navigation ends successfully.
|
|
1610
1610
|
*
|
|
1611
|
-
* @see
|
|
1612
|
-
* @see
|
|
1613
|
-
* @see
|
|
1611
|
+
* @see {@link NavigationStart}
|
|
1612
|
+
* @see {@link NavigationCancel}
|
|
1613
|
+
* @see {@link NavigationError}
|
|
1614
1614
|
*
|
|
1615
1615
|
* @publicApi
|
|
1616
1616
|
*/
|
|
@@ -1632,9 +1632,9 @@ export declare class NavigationEnd extends RouterEvent {
|
|
|
1632
1632
|
/**
|
|
1633
1633
|
* An event triggered when a navigation fails due to an unexpected error.
|
|
1634
1634
|
*
|
|
1635
|
-
* @see
|
|
1636
|
-
* @see
|
|
1637
|
-
* @see
|
|
1635
|
+
* @see {@link NavigationStart}
|
|
1636
|
+
* @see {@link NavigationEnd}
|
|
1637
|
+
* @see {@link NavigationCancel}
|
|
1638
1638
|
*
|
|
1639
1639
|
* @publicApi
|
|
1640
1640
|
*/
|
|
@@ -1670,8 +1670,8 @@ export declare class NavigationError extends RouterEvent {
|
|
|
1670
1670
|
/**
|
|
1671
1671
|
* A type alias for providers returned by `withNavigationErrorHandler` for use with `provideRouter`.
|
|
1672
1672
|
*
|
|
1673
|
-
* @see
|
|
1674
|
-
* @see
|
|
1673
|
+
* @see {@link withNavigationErrorHandler}
|
|
1674
|
+
* @see {@link provideRouter}
|
|
1675
1675
|
*
|
|
1676
1676
|
* @publicApi
|
|
1677
1677
|
*/
|
|
@@ -1684,12 +1684,12 @@ export declare type NavigationErrorHandlerFeature = RouterFeature<RouterFeatureK
|
|
|
1684
1684
|
* Supply an object containing any of these properties to a `Router` navigation function to
|
|
1685
1685
|
* control how the target URL should be constructed or interpreted.
|
|
1686
1686
|
*
|
|
1687
|
-
* @see
|
|
1688
|
-
* @see
|
|
1689
|
-
* @see
|
|
1687
|
+
* @see {@link Router#navigate}
|
|
1688
|
+
* @see {@link Router#navigateByUrl}
|
|
1689
|
+
* @see {@link Router#createurltree}
|
|
1690
1690
|
* @see [Routing and Navigation guide](guide/router)
|
|
1691
|
-
* @see UrlCreationOptions
|
|
1692
|
-
* @see NavigationBehaviorOptions
|
|
1691
|
+
* @see {@link UrlCreationOptions}
|
|
1692
|
+
* @see {@link NavigationBehaviorOptions}
|
|
1693
1693
|
*
|
|
1694
1694
|
* @publicApi
|
|
1695
1695
|
*/
|
|
@@ -1750,7 +1750,7 @@ export declare const enum NavigationSkippedCode {
|
|
|
1750
1750
|
* A navigation was skipped because the configured `UrlHandlingStrategy` return `false` for both
|
|
1751
1751
|
* the current Router URL and the target of the navigation.
|
|
1752
1752
|
*
|
|
1753
|
-
* @see UrlHandlingStrategy
|
|
1753
|
+
* @see {@link UrlHandlingStrategy}
|
|
1754
1754
|
*/
|
|
1755
1755
|
IgnoredByUrlHandlingStrategy = 1
|
|
1756
1756
|
}
|
|
@@ -1766,9 +1766,9 @@ export declare class NavigationStart extends RouterEvent {
|
|
|
1766
1766
|
* Identifies the call or event that triggered the navigation.
|
|
1767
1767
|
* An `imperative` trigger is a call to `router.navigateByUrl()` or `router.navigate()`.
|
|
1768
1768
|
*
|
|
1769
|
-
* @see
|
|
1770
|
-
* @see
|
|
1771
|
-
* @see
|
|
1769
|
+
* @see {@link NavigationEnd}
|
|
1770
|
+
* @see {@link NavigationCancel}
|
|
1771
|
+
* @see {@link NavigationError}
|
|
1772
1772
|
*/
|
|
1773
1773
|
navigationTrigger?: NavigationTrigger;
|
|
1774
1774
|
/**
|
|
@@ -1853,10 +1853,10 @@ export declare class NoPreloading implements PreloadingStrategy {
|
|
|
1853
1853
|
* (configured by `runGuardsAndResolvers`).
|
|
1854
1854
|
*
|
|
1855
1855
|
* @publicApi
|
|
1856
|
-
* @see
|
|
1857
|
-
* @see
|
|
1858
|
-
* @see
|
|
1859
|
-
* @see
|
|
1856
|
+
* @see {@link RouteReuseStrategy}
|
|
1857
|
+
* @see {@link RunGuardsAndResolvers}
|
|
1858
|
+
* @see {@link NavigationBehaviorOptions}
|
|
1859
|
+
* @see {@link RouterConfigOptions}
|
|
1860
1860
|
*/
|
|
1861
1861
|
export declare type OnSameUrlNavigation = 'reload' | 'ignore';
|
|
1862
1862
|
|
|
@@ -1912,8 +1912,8 @@ export declare interface ParamMap {
|
|
|
1912
1912
|
|
|
1913
1913
|
/**
|
|
1914
1914
|
* A collection of matrix and query URL parameters.
|
|
1915
|
-
* @see
|
|
1916
|
-
* @see
|
|
1915
|
+
* @see {@link convertToParamMap}
|
|
1916
|
+
* @see {@link ParamMap}
|
|
1917
1917
|
*
|
|
1918
1918
|
* @publicApi
|
|
1919
1919
|
*/
|
|
@@ -1942,8 +1942,8 @@ export declare class PreloadAllModules implements PreloadingStrategy {
|
|
|
1942
1942
|
* A type alias that represents a feature which enables preloading in Router.
|
|
1943
1943
|
* The type is used to describe the return value of the `withPreloading` function.
|
|
1944
1944
|
*
|
|
1945
|
-
* @see
|
|
1946
|
-
* @see
|
|
1945
|
+
* @see {@link withPreloading}
|
|
1946
|
+
* @see {@link provideRouter}
|
|
1947
1947
|
*
|
|
1948
1948
|
* @publicApi
|
|
1949
1949
|
*/
|
|
@@ -1996,7 +1996,7 @@ export declare const PRIMARY_OUTLET = "primary";
|
|
|
1996
1996
|
* );
|
|
1997
1997
|
* ```
|
|
1998
1998
|
*
|
|
1999
|
-
* @see
|
|
1999
|
+
* @see {@link RouterFeatures}
|
|
2000
2000
|
*
|
|
2001
2001
|
* @publicApi
|
|
2002
2002
|
* @param routes A set of `Route`s to use for the application routing table.
|
|
@@ -2019,7 +2019,7 @@ export declare function provideRouter(routes: Routes, ...features: RouterFeature
|
|
|
2019
2019
|
* ```
|
|
2020
2020
|
*
|
|
2021
2021
|
* @deprecated If necessary, provide routes using the `ROUTES` `InjectionToken`.
|
|
2022
|
-
* @see
|
|
2022
|
+
* @see {@link ROUTES}
|
|
2023
2023
|
* @publicApi
|
|
2024
2024
|
*/
|
|
2025
2025
|
export declare function provideRoutes(routes: Routes): Provider[];
|
|
@@ -2032,8 +2032,8 @@ export declare function provideRoutes(routes: Routes): Provider[];
|
|
|
2032
2032
|
* - `"preserve"` : Preserve current parameters.
|
|
2033
2033
|
* - `""` : Replace current parameters with new parameters. This is the default behavior.
|
|
2034
2034
|
*
|
|
2035
|
-
* @see
|
|
2036
|
-
* @see
|
|
2035
|
+
* @see {@link UrlCreationOptions#queryParamsHandling}
|
|
2036
|
+
* @see {@link RouterLink}
|
|
2037
2037
|
* @publicApi
|
|
2038
2038
|
*/
|
|
2039
2039
|
export declare type QueryParamsHandling = 'merge' | 'preserve' | '';
|
|
@@ -2132,7 +2132,7 @@ export declare type QueryParamsHandling = 'merge' | 'preserve' | '';
|
|
|
2132
2132
|
* @deprecated Class-based `Route` resolvers are deprecated in favor of functional resolvers. An
|
|
2133
2133
|
* injectable class can be used as a functional guard using the `inject` function: `resolve:
|
|
2134
2134
|
* {'user': () => inject(UserResolver).resolve()}`.
|
|
2135
|
-
* @see
|
|
2135
|
+
* @see {@link ResolveFn}
|
|
2136
2136
|
*/
|
|
2137
2137
|
export declare interface Resolve<T> {
|
|
2138
2138
|
resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<T> | Promise<T> | T;
|
|
@@ -2142,7 +2142,7 @@ export declare interface Resolve<T> {
|
|
|
2142
2142
|
*
|
|
2143
2143
|
* Represents the resolved data associated with a particular route.
|
|
2144
2144
|
*
|
|
2145
|
-
* @see
|
|
2145
|
+
* @see {@link Route#resolve}.
|
|
2146
2146
|
*
|
|
2147
2147
|
* @publicApi
|
|
2148
2148
|
*/
|
|
@@ -2152,7 +2152,7 @@ export declare type ResolveData = {
|
|
|
2152
2152
|
|
|
2153
2153
|
/**
|
|
2154
2154
|
* An event triggered at the end of the Resolve phase of routing.
|
|
2155
|
-
* @see
|
|
2155
|
+
* @see {@link ResolveStart}.
|
|
2156
2156
|
*
|
|
2157
2157
|
* @publicApi
|
|
2158
2158
|
*/
|
|
@@ -2213,7 +2213,7 @@ export declare class ResolveEnd extends RouterEvent {
|
|
|
2213
2213
|
* The order of execution is: baseGuard, childGuard, baseDataResolver, childDataResolver.
|
|
2214
2214
|
*
|
|
2215
2215
|
* @publicApi
|
|
2216
|
-
* @see
|
|
2216
|
+
* @see {@link Route}
|
|
2217
2217
|
*/
|
|
2218
2218
|
export declare type ResolveFn<T> = (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => Observable<T> | Promise<T> | T;
|
|
2219
2219
|
|
|
@@ -2223,7 +2223,7 @@ export declare type ResolveFn<T> = (route: ActivatedRouteSnapshot, state: Router
|
|
|
2223
2223
|
* Runs in the "resolve" phase whether or not there is anything to resolve.
|
|
2224
2224
|
* In future, may change to only run when there are things to be resolved.
|
|
2225
2225
|
*
|
|
2226
|
-
* @see
|
|
2226
|
+
* @see {@link ResolveEnd}
|
|
2227
2227
|
*
|
|
2228
2228
|
* @publicApi
|
|
2229
2229
|
*/
|
|
@@ -2475,7 +2475,7 @@ export declare interface Route {
|
|
|
2475
2475
|
* Used to define a page title for the route. This can be a static string or an `Injectable` that
|
|
2476
2476
|
* implements `Resolve`.
|
|
2477
2477
|
*
|
|
2478
|
-
* @see
|
|
2478
|
+
* @see {@link TitleStrategy}
|
|
2479
2479
|
*/
|
|
2480
2480
|
title?: string | Type<Resolve<string>> | ResolveFn<string>;
|
|
2481
2481
|
/**
|
|
@@ -2612,7 +2612,7 @@ export declare interface Route {
|
|
|
2612
2612
|
* - `pathParamsOrQueryParamsChange` : Rerun guards and resolvers when the path params
|
|
2613
2613
|
* change or query params have changed. This does not include matrix parameters.
|
|
2614
2614
|
*
|
|
2615
|
-
* @see
|
|
2615
|
+
* @see {@link RunGuardsAndResolvers}
|
|
2616
2616
|
*/
|
|
2617
2617
|
runGuardsAndResolvers?: RunGuardsAndResolvers;
|
|
2618
2618
|
/**
|
|
@@ -2629,7 +2629,7 @@ export declare interface Route {
|
|
|
2629
2629
|
/**
|
|
2630
2630
|
* An event triggered when a route has been lazy loaded.
|
|
2631
2631
|
*
|
|
2632
|
-
* @see
|
|
2632
|
+
* @see {@link RouteConfigLoadStart}
|
|
2633
2633
|
*
|
|
2634
2634
|
* @publicApi
|
|
2635
2635
|
*/
|
|
@@ -2646,7 +2646,7 @@ export declare class RouteConfigLoadEnd {
|
|
|
2646
2646
|
/**
|
|
2647
2647
|
* An event triggered before lazy loading a route configuration.
|
|
2648
2648
|
*
|
|
2649
|
-
* @see
|
|
2649
|
+
* @see {@link RouteConfigLoadEnd}
|
|
2650
2650
|
*
|
|
2651
2651
|
* @publicApi
|
|
2652
2652
|
*/
|
|
@@ -2688,7 +2688,7 @@ declare class RoutedComponentInputBinder {
|
|
|
2688
2688
|
*
|
|
2689
2689
|
* A service that provides navigation among views and URL manipulation capabilities.
|
|
2690
2690
|
*
|
|
2691
|
-
* @see
|
|
2691
|
+
* @see {@link Route}.
|
|
2692
2692
|
* @see [Routing and Navigation Guide](guide/router).
|
|
2693
2693
|
*
|
|
2694
2694
|
* @ngModule RouterModule
|
|
@@ -2731,7 +2731,7 @@ export declare class Router {
|
|
|
2731
2731
|
*
|
|
2732
2732
|
* @deprecated Subscribe to the `Router` events and watch for `NavigationError` instead.
|
|
2733
2733
|
* `provideRouter` has the `withNavigationErrorHandler` feature to make this easier.
|
|
2734
|
-
* @see
|
|
2734
|
+
* @see {@link withNavigationErrorHandler}
|
|
2735
2735
|
*/
|
|
2736
2736
|
errorHandler: (error: any) => any;
|
|
2737
2737
|
/**
|
|
@@ -2742,7 +2742,7 @@ export declare class Router {
|
|
|
2742
2742
|
*
|
|
2743
2743
|
* @deprecated URI parsing errors should be handled in the `UrlSerializer`.
|
|
2744
2744
|
*
|
|
2745
|
-
* @see
|
|
2745
|
+
* @see {@link RouterModule}
|
|
2746
2746
|
*/
|
|
2747
2747
|
malformedUriErrorHandler: (error: URIError, urlSerializer: UrlSerializer, url: string) => UrlTree;
|
|
2748
2748
|
/**
|
|
@@ -2778,9 +2778,9 @@ export declare class Router {
|
|
|
2778
2778
|
*
|
|
2779
2779
|
*
|
|
2780
2780
|
* @deprecated Configure this through `provideRouter` or `RouterModule.forRoot` instead.
|
|
2781
|
-
* @see
|
|
2782
|
-
* @see
|
|
2783
|
-
* @see
|
|
2781
|
+
* @see {@link withRouterConfig}
|
|
2782
|
+
* @see {@link provideRouter}
|
|
2783
|
+
* @see {@link RouterModule}
|
|
2784
2784
|
*/
|
|
2785
2785
|
onSameUrlNavigation: OnSameUrlNavigation;
|
|
2786
2786
|
/**
|
|
@@ -2793,9 +2793,9 @@ export declare class Router {
|
|
|
2793
2793
|
* for all child routes.
|
|
2794
2794
|
*
|
|
2795
2795
|
* @deprecated Configure this through `provideRouter` or `RouterModule.forRoot` instead.
|
|
2796
|
-
* @see
|
|
2797
|
-
* @see
|
|
2798
|
-
* @see
|
|
2796
|
+
* @see {@link withRouterConfig}
|
|
2797
|
+
* @see {@link provideRouter}
|
|
2798
|
+
* @see {@link RouterModule}
|
|
2799
2799
|
*/
|
|
2800
2800
|
paramsInheritanceStrategy: 'emptyOnly' | 'always';
|
|
2801
2801
|
/**
|
|
@@ -2806,9 +2806,9 @@ export declare class Router {
|
|
|
2806
2806
|
* you can show an error message with the URL that failed.
|
|
2807
2807
|
*
|
|
2808
2808
|
* @deprecated Configure this through `provideRouter` or `RouterModule.forRoot` instead.
|
|
2809
|
-
* @see
|
|
2810
|
-
* @see
|
|
2811
|
-
* @see
|
|
2809
|
+
* @see {@link withRouterConfig}
|
|
2810
|
+
* @see {@link provideRouter}
|
|
2811
|
+
* @see {@link RouterModule}
|
|
2812
2812
|
*/
|
|
2813
2813
|
urlUpdateStrategy: 'deferred' | 'eager';
|
|
2814
2814
|
/**
|
|
@@ -2833,9 +2833,9 @@ export declare class Router {
|
|
|
2833
2833
|
* The default value is `replace`.
|
|
2834
2834
|
*
|
|
2835
2835
|
* @deprecated Configure this through `provideRouter` or `RouterModule.forRoot` instead.
|
|
2836
|
-
* @see
|
|
2837
|
-
* @see
|
|
2838
|
-
* @see
|
|
2836
|
+
* @see {@link withRouterConfig}
|
|
2837
|
+
* @see {@link provideRouter}
|
|
2838
|
+
* @see {@link RouterModule}
|
|
2839
2839
|
*/
|
|
2840
2840
|
canceledNavigationResolution: 'replace' | 'computed';
|
|
2841
2841
|
config: Routes;
|
|
@@ -3095,7 +3095,7 @@ export declare interface RouterConfigOptions {
|
|
|
3095
3095
|
*
|
|
3096
3096
|
* If unset, the `Router` will use `'ignore'`.
|
|
3097
3097
|
*
|
|
3098
|
-
* @see
|
|
3098
|
+
* @see {@link OnSameUrlNavigation}
|
|
3099
3099
|
*/
|
|
3100
3100
|
onSameUrlNavigation?: OnSameUrlNavigation;
|
|
3101
3101
|
/**
|
|
@@ -3126,8 +3126,8 @@ export declare interface RouterConfigOptions {
|
|
|
3126
3126
|
/**
|
|
3127
3127
|
* A type alias for providers returned by `withRouterConfig` for use with `provideRouter`.
|
|
3128
3128
|
*
|
|
3129
|
-
* @see
|
|
3130
|
-
* @see
|
|
3129
|
+
* @see {@link withRouterConfig}
|
|
3130
|
+
* @see {@link provideRouter}
|
|
3131
3131
|
*
|
|
3132
3132
|
* @publicApi
|
|
3133
3133
|
*/
|
|
@@ -3171,7 +3171,7 @@ export declare abstract class RouteReuseStrategy {
|
|
|
3171
3171
|
* class MyService {
|
|
3172
3172
|
* constructor(public router: Router) {
|
|
3173
3173
|
* router.events.pipe(
|
|
3174
|
-
* filter((e: Event): e is RouterEvent => e instanceof RouterEvent)
|
|
3174
|
+
* filter((e: Event | RouterEvent): e is RouterEvent => e instanceof RouterEvent)
|
|
3175
3175
|
* ).subscribe((e: RouterEvent) => {
|
|
3176
3176
|
* // Do something
|
|
3177
3177
|
* });
|
|
@@ -3179,7 +3179,7 @@ export declare abstract class RouteReuseStrategy {
|
|
|
3179
3179
|
* }
|
|
3180
3180
|
* ```
|
|
3181
3181
|
*
|
|
3182
|
-
* @see
|
|
3182
|
+
* @see {@link Event}
|
|
3183
3183
|
* @see [Router events summary](guide/router-reference#router-events)
|
|
3184
3184
|
* @publicApi
|
|
3185
3185
|
*/
|
|
@@ -3226,7 +3226,7 @@ declare const enum RouterFeatureKind {
|
|
|
3226
3226
|
* See documentation for each symbol to find corresponding function name. See also `provideRouter`
|
|
3227
3227
|
* documentation on how to use those functions.
|
|
3228
3228
|
*
|
|
3229
|
-
* @see
|
|
3229
|
+
* @see {@link provideRouter}
|
|
3230
3230
|
*
|
|
3231
3231
|
* @publicApi
|
|
3232
3232
|
*/
|
|
@@ -3235,8 +3235,8 @@ export declare type RouterFeatures = PreloadingFeature | DebugTracingFeature | I
|
|
|
3235
3235
|
/**
|
|
3236
3236
|
* A type alias for providers returned by `withHashLocation` for use with `provideRouter`.
|
|
3237
3237
|
*
|
|
3238
|
-
* @see
|
|
3239
|
-
* @see
|
|
3238
|
+
* @see {@link withHashLocation}
|
|
3239
|
+
* @see {@link provideRouter}
|
|
3240
3240
|
*
|
|
3241
3241
|
* @publicApi
|
|
3242
3242
|
*/
|
|
@@ -3266,7 +3266,7 @@ export declare type RouterHashLocationFeature = RouterFeature<RouterFeatureKind.
|
|
|
3266
3266
|
* For instance, suppose the current URL is `/user/(box//aux:team)`.
|
|
3267
3267
|
* The link `<a [routerLink]="['/user/jim']">Jim</a>` creates the URL
|
|
3268
3268
|
* `/user/(jim//aux:team)`.
|
|
3269
|
-
* See {@link Router#createUrlTree
|
|
3269
|
+
* See {@link Router#createUrlTree} for more information.
|
|
3270
3270
|
*
|
|
3271
3271
|
* @usageNotes
|
|
3272
3272
|
*
|
|
@@ -3309,7 +3309,7 @@ export declare type RouterHashLocationFeature = RouterFeature<RouterFeatureKind.
|
|
|
3309
3309
|
* </a>
|
|
3310
3310
|
* ```
|
|
3311
3311
|
*
|
|
3312
|
-
* See {@link UrlCreationOptions
|
|
3312
|
+
* See {@link UrlCreationOptions#queryParamsHandling}.
|
|
3313
3313
|
*
|
|
3314
3314
|
* ### Preserving navigation history
|
|
3315
3315
|
*
|
|
@@ -3323,7 +3323,7 @@ export declare type RouterHashLocationFeature = RouterFeature<RouterFeatureKind.
|
|
|
3323
3323
|
* </a>
|
|
3324
3324
|
* ```
|
|
3325
3325
|
*
|
|
3326
|
-
* Use {@link Router
|
|
3326
|
+
* Use {@link Router#getCurrentNavigation} to retrieve a saved
|
|
3327
3327
|
* navigation-state value. For example, to capture the `tracingId` during the `NavigationStart`
|
|
3328
3328
|
* event:
|
|
3329
3329
|
*
|
|
@@ -3357,43 +3357,43 @@ declare class RouterLink implements OnChanges, OnDestroy {
|
|
|
3357
3357
|
*/
|
|
3358
3358
|
target?: string;
|
|
3359
3359
|
/**
|
|
3360
|
-
* Passed to {@link Router#createUrlTree
|
|
3360
|
+
* Passed to {@link Router#createUrlTree} as part of the
|
|
3361
3361
|
* `UrlCreationOptions`.
|
|
3362
|
-
* @see {@link UrlCreationOptions#queryParams
|
|
3363
|
-
* @see {@link Router#createUrlTree
|
|
3362
|
+
* @see {@link UrlCreationOptions#queryParams}
|
|
3363
|
+
* @see {@link Router#createUrlTree}
|
|
3364
3364
|
*/
|
|
3365
3365
|
queryParams?: Params | null;
|
|
3366
3366
|
/**
|
|
3367
|
-
* Passed to {@link Router#createUrlTree
|
|
3367
|
+
* Passed to {@link Router#createUrlTree} as part of the
|
|
3368
3368
|
* `UrlCreationOptions`.
|
|
3369
|
-
* @see {@link UrlCreationOptions#fragment
|
|
3370
|
-
* @see {@link Router#createUrlTree
|
|
3369
|
+
* @see {@link UrlCreationOptions#fragment}
|
|
3370
|
+
* @see {@link Router#createUrlTree}
|
|
3371
3371
|
*/
|
|
3372
3372
|
fragment?: string;
|
|
3373
3373
|
/**
|
|
3374
|
-
* Passed to {@link Router#createUrlTree
|
|
3374
|
+
* Passed to {@link Router#createUrlTree} as part of the
|
|
3375
3375
|
* `UrlCreationOptions`.
|
|
3376
|
-
* @see {@link UrlCreationOptions#queryParamsHandling
|
|
3377
|
-
* @see {@link Router#createUrlTree
|
|
3376
|
+
* @see {@link UrlCreationOptions#queryParamsHandling}
|
|
3377
|
+
* @see {@link Router#createUrlTree}
|
|
3378
3378
|
*/
|
|
3379
3379
|
queryParamsHandling?: QueryParamsHandling | null;
|
|
3380
3380
|
/**
|
|
3381
|
-
* Passed to {@link Router#navigateByUrl
|
|
3381
|
+
* Passed to {@link Router#navigateByUrl} as part of the
|
|
3382
3382
|
* `NavigationBehaviorOptions`.
|
|
3383
|
-
* @see {@link NavigationBehaviorOptions#state
|
|
3384
|
-
* @see {@link Router#navigateByUrl
|
|
3383
|
+
* @see {@link NavigationBehaviorOptions#state}
|
|
3384
|
+
* @see {@link Router#navigateByUrl}
|
|
3385
3385
|
*/
|
|
3386
3386
|
state?: {
|
|
3387
3387
|
[k: string]: any;
|
|
3388
3388
|
};
|
|
3389
3389
|
/**
|
|
3390
|
-
* Passed to {@link Router#createUrlTree
|
|
3390
|
+
* Passed to {@link Router#createUrlTree} as part of the
|
|
3391
3391
|
* `UrlCreationOptions`.
|
|
3392
3392
|
* Specify a value here when you do not want to use the default value
|
|
3393
3393
|
* for `routerLink`, which is the current activated route.
|
|
3394
3394
|
* Note that a value of `undefined` here will use the `routerLink` default.
|
|
3395
|
-
* @see {@link UrlCreationOptions#relativeTo
|
|
3396
|
-
* @see {@link Router#createUrlTree
|
|
3395
|
+
* @see {@link UrlCreationOptions#relativeTo}
|
|
3396
|
+
* @see {@link Router#createUrlTree}
|
|
3397
3397
|
*/
|
|
3398
3398
|
relativeTo?: ActivatedRoute | null;
|
|
3399
3399
|
private commands;
|
|
@@ -3402,24 +3402,24 @@ declare class RouterLink implements OnChanges, OnDestroy {
|
|
|
3402
3402
|
private subscription?;
|
|
3403
3403
|
constructor(router: Router, route: ActivatedRoute, tabIndexAttribute: string | null | undefined, renderer: Renderer2, el: ElementRef, locationStrategy?: LocationStrategy | undefined);
|
|
3404
3404
|
/**
|
|
3405
|
-
* Passed to {@link Router#createUrlTree
|
|
3405
|
+
* Passed to {@link Router#createUrlTree} as part of the
|
|
3406
3406
|
* `UrlCreationOptions`.
|
|
3407
|
-
* @see {@link UrlCreationOptions#preserveFragment
|
|
3408
|
-
* @see {@link Router#createUrlTree
|
|
3407
|
+
* @see {@link UrlCreationOptions#preserveFragment}
|
|
3408
|
+
* @see {@link Router#createUrlTree}
|
|
3409
3409
|
*/
|
|
3410
3410
|
preserveFragment: boolean;
|
|
3411
3411
|
/**
|
|
3412
|
-
* Passed to {@link Router#navigateByUrl
|
|
3412
|
+
* Passed to {@link Router#navigateByUrl} as part of the
|
|
3413
3413
|
* `NavigationBehaviorOptions`.
|
|
3414
|
-
* @see {@link NavigationBehaviorOptions#skipLocationChange
|
|
3415
|
-
* @see {@link Router#navigateByUrl
|
|
3414
|
+
* @see {@link NavigationBehaviorOptions#skipLocationChange}
|
|
3415
|
+
* @see {@link Router#navigateByUrl}
|
|
3416
3416
|
*/
|
|
3417
3417
|
skipLocationChange: boolean;
|
|
3418
3418
|
/**
|
|
3419
|
-
* Passed to {@link Router#navigateByUrl
|
|
3419
|
+
* Passed to {@link Router#navigateByUrl} as part of the
|
|
3420
3420
|
* `NavigationBehaviorOptions`.
|
|
3421
|
-
* @see {@link NavigationBehaviorOptions#replaceUrl
|
|
3422
|
-
* @see {@link Router#navigateByUrl
|
|
3421
|
+
* @see {@link NavigationBehaviorOptions#replaceUrl}
|
|
3422
|
+
* @see {@link Router#navigateByUrl}
|
|
3423
3423
|
*/
|
|
3424
3424
|
replaceUrl: boolean;
|
|
3425
3425
|
/**
|
|
@@ -3430,11 +3430,11 @@ declare class RouterLink implements OnChanges, OnDestroy {
|
|
|
3430
3430
|
/** @nodoc */
|
|
3431
3431
|
ngOnChanges(changes: SimpleChanges): void;
|
|
3432
3432
|
/**
|
|
3433
|
-
* Commands to pass to {@link Router#createUrlTree
|
|
3434
|
-
* - **array**: commands to pass to {@link Router#createUrlTree
|
|
3433
|
+
* Commands to pass to {@link Router#createUrlTree}.
|
|
3434
|
+
* - **array**: commands to pass to {@link Router#createUrlTree}.
|
|
3435
3435
|
* - **string**: shorthand for array of commands with just the string, i.e. `['/route']`
|
|
3436
3436
|
* - **null|undefined**: effectively disables the `routerLink`
|
|
3437
|
-
* @see {@link Router#createUrlTree
|
|
3437
|
+
* @see {@link Router#createUrlTree}
|
|
3438
3438
|
*/
|
|
3439
3439
|
set routerLink(commands: any[] | string | null | undefined);
|
|
3440
3440
|
/** @nodoc */
|
|
@@ -3445,7 +3445,7 @@ declare class RouterLink implements OnChanges, OnDestroy {
|
|
|
3445
3445
|
private applyAttributeValue;
|
|
3446
3446
|
get urlTree(): UrlTree | null;
|
|
3447
3447
|
static ɵfac: i0.ɵɵFactoryDeclaration<RouterLink, [null, null, { attribute: "tabindex"; }, null, null, null]>;
|
|
3448
|
-
static ɵdir: i0.ɵɵDirectiveDeclaration<RouterLink, "[routerLink]", never, { "target": { "alias": "target"; "required": false; }; "queryParams": { "alias": "queryParams"; "required": false; }; "fragment": { "alias": "fragment"; "required": false; }; "queryParamsHandling": { "alias": "queryParamsHandling"; "required": false; }; "state": { "alias": "state"; "required": false; }; "relativeTo": { "alias": "relativeTo"; "required": false; }; "preserveFragment": { "alias": "preserveFragment"; "required": false; }; "skipLocationChange": { "alias": "skipLocationChange"; "required": false; }; "replaceUrl": { "alias": "replaceUrl"; "required": false; }; "routerLink": { "alias": "routerLink"; "required": false; }; }, {}, never, never, true, never
|
|
3448
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<RouterLink, "[routerLink]", never, { "target": { "alias": "target"; "required": false; }; "queryParams": { "alias": "queryParams"; "required": false; }; "fragment": { "alias": "fragment"; "required": false; }; "queryParamsHandling": { "alias": "queryParamsHandling"; "required": false; }; "state": { "alias": "state"; "required": false; }; "relativeTo": { "alias": "relativeTo"; "required": false; }; "preserveFragment": { "alias": "preserveFragment"; "required": false; }; "skipLocationChange": { "alias": "skipLocationChange"; "required": false; }; "replaceUrl": { "alias": "replaceUrl"; "required": false; }; "routerLink": { "alias": "routerLink"; "required": false; }; }, {}, never, never, true, never>;
|
|
3449
3449
|
static ngAcceptInputType_preserveFragment: unknown;
|
|
3450
3450
|
static ngAcceptInputType_skipLocationChange: unknown;
|
|
3451
3451
|
static ngAcceptInputType_replaceUrl: unknown;
|
|
@@ -3582,7 +3582,7 @@ export declare class RouterLinkActive implements OnChanges, OnDestroy, AfterCont
|
|
|
3582
3582
|
private isLinkActive;
|
|
3583
3583
|
private hasActiveLinks;
|
|
3584
3584
|
static ɵfac: i0.ɵɵFactoryDeclaration<RouterLinkActive, [null, null, null, null, { optional: true; }]>;
|
|
3585
|
-
static ɵdir: i0.ɵɵDirectiveDeclaration<RouterLinkActive, "[routerLinkActive]", ["routerLinkActive"], { "routerLinkActiveOptions": { "alias": "routerLinkActiveOptions"; "required": false; }; "ariaCurrentWhenActive": { "alias": "ariaCurrentWhenActive"; "required": false; }; "routerLinkActive": { "alias": "routerLinkActive"; "required": false; }; }, { "isActiveChange": "isActiveChange"; }, ["links"], never, true, never
|
|
3585
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<RouterLinkActive, "[routerLinkActive]", ["routerLinkActive"], { "routerLinkActiveOptions": { "alias": "routerLinkActiveOptions"; "required": false; }; "ariaCurrentWhenActive": { "alias": "ariaCurrentWhenActive"; "required": false; }; "routerLinkActive": { "alias": "routerLinkActive"; "required": false; }; }, { "isActiveChange": "isActiveChange"; }, ["links"], never, true, never>;
|
|
3586
3586
|
}
|
|
3587
3587
|
|
|
3588
3588
|
/**
|
|
@@ -3694,8 +3694,8 @@ export declare class RouterModule {
|
|
|
3694
3694
|
*
|
|
3695
3695
|
* @see [Routing tutorial](guide/router-tutorial-toh#named-outlets "Example of a named
|
|
3696
3696
|
* outlet and secondary route configuration").
|
|
3697
|
-
* @see
|
|
3698
|
-
* @see
|
|
3697
|
+
* @see {@link RouterLink}
|
|
3698
|
+
* @see {@link Route}
|
|
3699
3699
|
* @ngModule RouterModule
|
|
3700
3700
|
*
|
|
3701
3701
|
* @publicApi
|
|
@@ -3755,7 +3755,7 @@ export declare class RouterOutlet implements OnDestroy, OnInit, RouterOutletCont
|
|
|
3755
3755
|
deactivate(): void;
|
|
3756
3756
|
activateWith(activatedRoute: ActivatedRoute, environmentInjector?: EnvironmentInjector | null): void;
|
|
3757
3757
|
static ɵfac: i0.ɵɵFactoryDeclaration<RouterOutlet, never>;
|
|
3758
|
-
static ɵdir: i0.ɵɵDirectiveDeclaration<RouterOutlet, "router-outlet", ["outlet"], { "name": { "alias": "name"; "required": false; }; }, { "activateEvents": "activate"; "deactivateEvents": "deactivate"; "attachEvents": "attach"; "detachEvents": "detach"; }, never, never, true, never
|
|
3758
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<RouterOutlet, "router-outlet", ["outlet"], { "name": { "alias": "name"; "required": false; }; }, { "activateEvents": "activate"; "deactivateEvents": "deactivate"; "attachEvents": "attach"; "detachEvents": "detach"; }, never, never, true, never>;
|
|
3759
3759
|
}
|
|
3760
3760
|
|
|
3761
3761
|
/**
|
|
@@ -3768,7 +3768,7 @@ export declare class RouterOutlet implements OnDestroy, OnInit, RouterOutletCont
|
|
|
3768
3768
|
* `ChildrenOutletContexts#onChildOutletDestroyed`. When the `Router` identifies a matched `Route`,
|
|
3769
3769
|
* it looks for a registered outlet in the `ChildrenOutletContexts` and activates it.
|
|
3770
3770
|
*
|
|
3771
|
-
* @see
|
|
3771
|
+
* @see {@link ChildrenOutletContexts}
|
|
3772
3772
|
* @publicApi
|
|
3773
3773
|
*/
|
|
3774
3774
|
export declare interface RouterOutletContract {
|
|
@@ -3894,7 +3894,7 @@ export declare class RouterPreloader implements OnDestroy {
|
|
|
3894
3894
|
* }
|
|
3895
3895
|
* ```
|
|
3896
3896
|
*
|
|
3897
|
-
* @see
|
|
3897
|
+
* @see {@link ActivatedRoute}
|
|
3898
3898
|
* @see [Getting route information](guide/router#getting-route-information)
|
|
3899
3899
|
*
|
|
3900
3900
|
* @publicApi
|
|
@@ -3955,8 +3955,8 @@ export declare const ROUTES: InjectionToken<Route[][]>;
|
|
|
3955
3955
|
* An array of `Route` objects, used in `Router.config` and for nested route configurations
|
|
3956
3956
|
* in `Route.children`.
|
|
3957
3957
|
*
|
|
3958
|
-
* @see
|
|
3959
|
-
* @see
|
|
3958
|
+
* @see {@link Route}
|
|
3959
|
+
* @see {@link Router}
|
|
3960
3960
|
* @see [Router configuration guide](guide/router-reference#configuration)
|
|
3961
3961
|
* @publicApi
|
|
3962
3962
|
*/
|
|
@@ -4001,7 +4001,7 @@ export declare class RoutesRecognized extends RouterEvent {
|
|
|
4001
4001
|
* - `pathParamsOrQueryParamsChange` : Rerun guards and resolvers when the path params
|
|
4002
4002
|
* change or query params have changed. This does not include matrix parameters.
|
|
4003
4003
|
*
|
|
4004
|
-
* @see
|
|
4004
|
+
* @see {@link Route#runGuardsAndResolvers}
|
|
4005
4005
|
* @publicApi
|
|
4006
4006
|
*/
|
|
4007
4007
|
export declare type RunGuardsAndResolvers = 'pathParamsChange' | 'pathParamsOrQueryParamsChange' | 'paramsChange' | 'paramsOrQueryParamsChange' | 'always' | ((from: ActivatedRouteSnapshot, to: ActivatedRouteSnapshot) => boolean);
|
|
@@ -4088,8 +4088,8 @@ declare class TreeNode<T> {
|
|
|
4088
4088
|
* Supply an object containing any of these properties to a `Router` navigation function to
|
|
4089
4089
|
* control how the target URL should be constructed.
|
|
4090
4090
|
*
|
|
4091
|
-
* @see
|
|
4092
|
-
* @see
|
|
4091
|
+
* @see {@link Router#navigate}
|
|
4092
|
+
* @see {@link Router#createUrlTree}
|
|
4093
4093
|
* @see [Routing and Navigation guide](guide/router)
|
|
4094
4094
|
*
|
|
4095
4095
|
* @publicApi
|
|
@@ -4245,7 +4245,7 @@ export declare type UrlMatcher = (segments: UrlSegment[], group: UrlSegmentGroup
|
|
|
4245
4245
|
* * `consumed` is an array of the consumed URL segments.
|
|
4246
4246
|
* * `posParams` is a map of positional parameters.
|
|
4247
4247
|
*
|
|
4248
|
-
* @see
|
|
4248
|
+
* @see {@link UrlMatcher}
|
|
4249
4249
|
* @publicApi
|
|
4250
4250
|
*/
|
|
4251
4251
|
export declare type UrlMatchResult = {
|
|
@@ -4448,7 +4448,7 @@ export declare function withComponentInputBinding(): ComponentInputBindingFeatur
|
|
|
4448
4448
|
* );
|
|
4449
4449
|
* ```
|
|
4450
4450
|
*
|
|
4451
|
-
* @see
|
|
4451
|
+
* @see {@link provideRouter}
|
|
4452
4452
|
*
|
|
4453
4453
|
* @returns A set of providers for use with `provideRouter`.
|
|
4454
4454
|
*
|
|
@@ -4476,7 +4476,7 @@ export declare function withDebugTracing(): DebugTracingFeature;
|
|
|
4476
4476
|
* );
|
|
4477
4477
|
* ```
|
|
4478
4478
|
*
|
|
4479
|
-
* @see
|
|
4479
|
+
* @see {@link provideRouter}
|
|
4480
4480
|
*
|
|
4481
4481
|
* @returns A set of providers for use with `provideRouter`.
|
|
4482
4482
|
*
|
|
@@ -4504,7 +4504,7 @@ export declare function withDisabledInitialNavigation(): DisabledInitialNavigati
|
|
|
4504
4504
|
* );
|
|
4505
4505
|
* ```
|
|
4506
4506
|
*
|
|
4507
|
-
* @see
|
|
4507
|
+
* @see {@link provideRouter}
|
|
4508
4508
|
*
|
|
4509
4509
|
* @publicApi
|
|
4510
4510
|
* @returns A set of providers for use with `provideRouter`.
|
|
@@ -4528,8 +4528,8 @@ export declare function withEnabledBlockingInitialNavigation(): EnabledBlockingI
|
|
|
4528
4528
|
* );
|
|
4529
4529
|
* ```
|
|
4530
4530
|
*
|
|
4531
|
-
* @see
|
|
4532
|
-
* @see
|
|
4531
|
+
* @see {@link provideRouter}
|
|
4532
|
+
* @see {@link HashLocationStrategy}
|
|
4533
4533
|
*
|
|
4534
4534
|
* @returns A set of providers for use with `provideRouter`.
|
|
4535
4535
|
*
|
|
@@ -4554,8 +4554,8 @@ export declare function withHashLocation(): RouterConfigurationFeature;
|
|
|
4554
4554
|
* );
|
|
4555
4555
|
* ```
|
|
4556
4556
|
*
|
|
4557
|
-
* @see
|
|
4558
|
-
* @see
|
|
4557
|
+
* @see {@link provideRouter}
|
|
4558
|
+
* @see {@link ViewportScroller}
|
|
4559
4559
|
*
|
|
4560
4560
|
* @publicApi
|
|
4561
4561
|
* @param options Set of configuration parameters to customize scrolling behavior, see
|
|
@@ -4585,9 +4585,9 @@ export declare function withInMemoryScrolling(options?: InMemoryScrollingOptions
|
|
|
4585
4585
|
* );
|
|
4586
4586
|
* ```
|
|
4587
4587
|
*
|
|
4588
|
-
* @see
|
|
4589
|
-
* @see
|
|
4590
|
-
* @see
|
|
4588
|
+
* @see {@link NavigationError}
|
|
4589
|
+
* @see {@link core/inject}
|
|
4590
|
+
* @see {@link EnvironmentInjector#runInContext}
|
|
4591
4591
|
*
|
|
4592
4592
|
* @returns A set of providers for use with `provideRouter`.
|
|
4593
4593
|
*
|
|
@@ -4613,7 +4613,7 @@ export declare function withNavigationErrorHandler(fn: (error: NavigationError)
|
|
|
4613
4613
|
* );
|
|
4614
4614
|
* ```
|
|
4615
4615
|
*
|
|
4616
|
-
* @see
|
|
4616
|
+
* @see {@link provideRouter}
|
|
4617
4617
|
*
|
|
4618
4618
|
* @param preloadingStrategy A reference to a class that implements a `PreloadingStrategy` that
|
|
4619
4619
|
* should be used.
|
|
@@ -4642,7 +4642,7 @@ export declare function withPreloading(preloadingStrategy: Type<PreloadingStrate
|
|
|
4642
4642
|
* );
|
|
4643
4643
|
* ```
|
|
4644
4644
|
*
|
|
4645
|
-
* @see
|
|
4645
|
+
* @see {@link provideRouter}
|
|
4646
4646
|
*
|
|
4647
4647
|
* @param options A set of parameters to configure Router, see `RouterConfigOptions` for
|
|
4648
4648
|
* additional information.
|
|
@@ -4676,7 +4676,7 @@ export declare function ɵafterNextNavigation(router: {
|
|
|
4676
4676
|
*/
|
|
4677
4677
|
export declare class ɵEmptyOutletComponent {
|
|
4678
4678
|
static ɵfac: i0.ɵɵFactoryDeclaration<ɵEmptyOutletComponent, never>;
|
|
4679
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<ɵEmptyOutletComponent, "ng-component", never, {}, {}, never, never, true, never
|
|
4679
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ɵEmptyOutletComponent, "ng-component", never, {}, {}, never, never, true, never>;
|
|
4680
4680
|
}
|
|
4681
4681
|
|
|
4682
4682
|
export declare type ɵRestoredState = {
|