cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(router): allow passing state to routerLink directives (#27198)

Browse Source 
This value will get written to the `history.state` entry.

FW-613 (related)
Related to #24617

PR Close #27198
This commit is contained in:
Jason Aden
2018-11-16 10:10:11 -08:00
committed by Igor Minar
parent 67f4a5d4bd
commit 73f6ed9be1
2 changed files with 64 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
packages/router/src/directives/router_link.ts
View File

@ -77,6 +77,27 @@ import {UrlTree} from '../url_tree';
* </a>
* ```
*
* You can provide a `state` value to be persisted to the browser's History.state
* property (See https://developer.mozilla.org/en-US/docs/Web/API/History#Properties). It's
* used as follows:
*
* ```
* <a [routerLink]="['/user/bob']" [state]="{tracingId: 123}">
* link to user component
* </a>
* ```
*
* And later the value can be read from the router through `router.getCurrentTransition.
* For example, to capture the `tracingId` above during the `NavigationStart` event:
*
* ```
* // Get NavigationStart events
* router.events.pipe(filter(e => e instanceof NavigationStart)).subscribe(e => {
* const transition = router.getCurrentTransition();
* tracingService.trace({id: transition.extras.state});
* });
* ```
*
* The router link directive always treats the provided input as a delta to the current url.
*
* For instance, if the current url is `/user/(box//aux:team)`.
@ -104,6 +125,7 @@ export class RouterLink {
@Input() skipLocationChange !: boolean;
// TODO(issue/24571): remove '!'.
@Input() replaceUrl !: boolean;
@Input() state?: {[k: string]: any};
private commands: any[] = [];
// TODO(issue/24571): remove '!'.
private preserve !: boolean;
@ -185,6 +207,7 @@ export class RouterLinkWithHref implements OnChanges, OnDestroy {
@Input() skipLocationChange !: boolean;
// TODO(issue/24571): remove '!'.
@Input() replaceUrl !: boolean;
@Input() state?: {[k: string]: any};
private commands: any[] = [];
private subscription: Subscription;
// TODO(issue/24571): remove '!'.
@ -237,6 +260,7 @@ export class RouterLinkWithHref implements OnChanges, OnDestroy {
const extras = {
skipLocationChange: attrBoolValue(this.skipLocationChange),
replaceUrl: attrBoolValue(this.replaceUrl),
state: this.state
};
this.router.navigateByUrl(this.urlTree, extras);
return false;