/** * @license * Copyright Google Inc. All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ import {LocationStrategy} from '@angular/common'; import {Attribute, Directive, ElementRef, HostBinding, HostListener, Input, OnChanges, OnDestroy, Renderer2, isDevMode} from '@angular/core'; import {Subscription} from 'rxjs'; import {QueryParamsHandling} from '../config'; import {NavigationEnd, RouterEvent} from '../events'; import {Router} from '../router'; import {ActivatedRoute} from '../router_state'; import {UrlTree} from '../url_tree'; /** * @description * * Lets you link to specific routes in your app. * * Consider the following route configuration: * `[{ path: 'user/:name', component: UserCmp }]`. * When linking to this `user/:name` route, you use the `RouterLink` directive. * * If the link is static, you can use the directive as follows: * `link to user component` * * If you use dynamic values to generate the link, you can pass an array of path * segments, followed by the params for each segment. * * For instance `['/team', teamId, 'user', userName, {details: true}]` * means that we want to generate a link to `/team/11/user/bob;details=true`. * * Multiple static segments can be merged into one * (e.g., `['/team/11/user', userName, {details: true}]`). * * The first segment name can be prepended with `/`, `./`, or `../`: * * If the first segment begins with `/`, the router will look up the route from the root of the * app. * * If the first segment begins with `./`, or doesn't begin with a slash, the router will * instead look in the children of the current activated route. * * And if the first segment begins with `../`, the router will go up one level. * * You can set query params and fragment as follows: * * ``` * * link to user component * * ``` * RouterLink will use these to generate this link: `/user/bob#education?debug=true`. * * (Deprecated in v4.0.0 use `queryParamsHandling` instead) You can also tell the * directive to preserve the current query params and fragment: * * ``` * * link to user component * * ``` * * You can tell the directive to how to handle queryParams, available options are: * - `'merge'`: merge the queryParams into the current queryParams * - `'preserve'`: preserve the current queryParams * - default/`''`: use the queryParams only * * Same options for {@link NavigationExtras#queryParamsHandling * NavigationExtras#queryParamsHandling}. * * ``` * * link to user component * * ``` * * 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)`. * * Then the following link `Jim` will generate the link * `/user/(jim//aux:team)`. * * See {@link Router#createUrlTree createUrlTree} for more information. * * @ngModule RouterModule * * */ @Directive({selector: ':not(a)[routerLink]'}) export class RouterLink { // TODO(issue/24571): remove '!'. @Input() queryParams !: {[k: string]: any}; // TODO(issue/24571): remove '!'. @Input() fragment !: string; // TODO(issue/24571): remove '!'. @Input() queryParamsHandling !: QueryParamsHandling; // TODO(issue/24571): remove '!'. @Input() preserveFragment !: boolean; // TODO(issue/24571): remove '!'. @Input() skipLocationChange !: boolean; // TODO(issue/24571): remove '!'. @Input() replaceUrl !: boolean; private commands: any[] = []; // TODO(issue/24571): remove '!'. private preserve !: boolean; constructor( private router: Router, private route: ActivatedRoute, @Attribute('tabindex') tabIndex: string, renderer: Renderer2, el: ElementRef) { if (tabIndex == null) { renderer.setAttribute(el.nativeElement, 'tabindex', '0'); } } @Input() set routerLink(commands: any[]|string) { if (commands != null) { this.commands = Array.isArray(commands) ? commands : [commands]; } else { this.commands = []; } } /** * @deprecated 4.0.0 use `queryParamsHandling` instead. */ @Input() set preserveQueryParams(value: boolean) { if (isDevMode() && console && console.warn) { console.warn('preserveQueryParams is deprecated!, use queryParamsHandling instead.'); } this.preserve = value; } @HostListener('click') onClick(): boolean { const extras = { skipLocationChange: attrBoolValue(this.skipLocationChange), replaceUrl: attrBoolValue(this.replaceUrl), }; this.router.navigateByUrl(this.urlTree, extras); return true; } get urlTree(): UrlTree { return this.router.createUrlTree(this.commands, { relativeTo: this.route, queryParams: this.queryParams, fragment: this.fragment, preserveQueryParams: attrBoolValue(this.preserve), queryParamsHandling: this.queryParamsHandling, preserveFragment: attrBoolValue(this.preserveFragment), }); } } /** * @description * * Lets you link to specific routes in your app. * * See `RouterLink` for more information. * * @ngModule RouterModule * * */ @Directive({selector: 'a[routerLink]'}) export class RouterLinkWithHref implements OnChanges, OnDestroy { // TODO(issue/24571): remove '!'. @HostBinding('attr.target') @Input() target !: string; // TODO(issue/24571): remove '!'. @Input() queryParams !: {[k: string]: any}; // TODO(issue/24571): remove '!'. @Input() fragment !: string; // TODO(issue/24571): remove '!'. @Input() queryParamsHandling !: QueryParamsHandling; // TODO(issue/24571): remove '!'. @Input() preserveFragment !: boolean; // TODO(issue/24571): remove '!'. @Input() skipLocationChange !: boolean; // TODO(issue/24571): remove '!'. @Input() replaceUrl !: boolean; private commands: any[] = []; private subscription: Subscription; // TODO(issue/24571): remove '!'. private preserve !: boolean; // the url displayed on the anchor element. // TODO(issue/24571): remove '!'. @HostBinding() href !: string; constructor( private router: Router, private route: ActivatedRoute, private locationStrategy: LocationStrategy) { this.subscription = router.events.subscribe((s: RouterEvent) => { if (s instanceof NavigationEnd) { this.updateTargetUrlAndHref(); } }); } @Input() set routerLink(commands: any[]|string) { if (commands != null) { this.commands = Array.isArray(commands) ? commands : [commands]; } else { this.commands = []; } } @Input() set preserveQueryParams(value: boolean) { if (isDevMode() && console && console.warn) { console.warn('preserveQueryParams is deprecated, use queryParamsHandling instead.'); } this.preserve = value; } ngOnChanges(changes: {}): any { this.updateTargetUrlAndHref(); } ngOnDestroy(): any { this.subscription.unsubscribe(); } @HostListener('click', ['$event.button', '$event.ctrlKey', '$event.metaKey', '$event.shiftKey']) onClick(button: number, ctrlKey: boolean, metaKey: boolean, shiftKey: boolean): boolean { if (button !== 0 || ctrlKey || metaKey || shiftKey) { return true; } if (typeof this.target === 'string' && this.target != '_self') { return true; } const extras = { skipLocationChange: attrBoolValue(this.skipLocationChange), replaceUrl: attrBoolValue(this.replaceUrl), }; this.router.navigateByUrl(this.urlTree, extras); return false; } private updateTargetUrlAndHref(): void { this.href = this.locationStrategy.prepareExternalUrl(this.router.serializeUrl(this.urlTree)); } get urlTree(): UrlTree { return this.router.createUrlTree(this.commands, { relativeTo: this.route, queryParams: this.queryParams, fragment: this.fragment, preserveQueryParams: attrBoolValue(this.preserve), queryParamsHandling: this.queryParamsHandling, preserveFragment: attrBoolValue(this.preserveFragment), }); } } function attrBoolValue(s: any): boolean { return s === '' || !!s; }