Skip to content

Commit

Permalink
fix(angular): tune routerLink default behaviour (#16405)
Browse files Browse the repository at this point in the history
refactor: use ng7 features for direction detection
  • Loading branch information
manucorporat authored Nov 20, 2018
1 parent 2884076 commit 72bc025
Show file tree
Hide file tree
Showing 6 changed files with 68 additions and 95 deletions.
29 changes: 9 additions & 20 deletions angular/src/directives/navigation/href-delegate.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@
import { Directive, ElementRef, HostListener, Input, Optional } from '@angular/core';
import { Router } from '@angular/router';
import { NavController, NavIntent } from '../../providers/nav-controller';
import { NavController, NavDirection } from '../../providers/nav-controller';

export type RouterDirection = 'forward' | 'back' | 'root' | 'auto';

@Directive({
selector: '[routerDirection],ion-anchor,ion-button,ion-item'
selector: '[routerLink],[routerDirection],ion-anchor,ion-button,ion-item'
})
export class HrefDelegate {

@Input() routerDirection: RouterDirection = 'forward';

@Input()
set routerLink(_: any) {
this.elementRef.nativeElement.button = true;
}
@Input() routerLink: any;
@Input() routerDirection: NavDirection = 'forward';

@Input()
set href(value: string) {
Expand All @@ -33,19 +28,13 @@ export class HrefDelegate {
@HostListener('click', ['$event'])
onClick(ev: Event) {
const url = this.href;
if (this.router && url != null && url[0] !== '#' && url.indexOf('://') === -1) {
if (this.routerDirection) {
this.navCtrl.setDirection(this.routerDirection);
}

if (!this.routerLink && this.router && url != null && url[0] !== '#' && url.indexOf('://') === -1) {
ev.preventDefault();
this.navCtrl.setIntent(textToIntent(this.routerDirection));
this.router.navigateByUrl(url);
}
}
}

function textToIntent(direction: RouterDirection) {
switch (direction) {
case 'forward': return NavIntent.Forward;
case 'back': return NavIntent.Back;
case 'root': return NavIntent.Root;
default: return NavIntent.Auto;
}
}
5 changes: 2 additions & 3 deletions angular/src/directives/navigation/ion-back-button.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Directive, ElementRef, HostListener, Input, Optional } from '@angular/core';
import { Router } from '@angular/router';
import { NavController, NavIntent } from '../../providers/nav-controller';
import { NavController } from '../../providers/nav-controller';
import { IonRouterOutlet } from './ion-router-outlet';

@Directive({
Expand Down Expand Up @@ -29,8 +29,7 @@ export class IonBackButton {
this.routerOutlet.pop();
ev.preventDefault();
} else if (this.router && this.defaultHref != null) {
this.navCtrl.setIntent(NavIntent.Back);
this.router.navigateByUrl(this.defaultHref);
this.navCtrl.navigateBack(this.defaultHref);
ev.preventDefault();
}
}
Expand Down
16 changes: 8 additions & 8 deletions angular/src/directives/navigation/stack-controller.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { ComponentRef, NgZone } from '@angular/core';
import { ActivatedRoute, Router } from '@angular/router';

import { NavController } from '../../providers/nav-controller';
import { NavController, NavDirection } from '../../providers/nav-controller';


export class StackController {
Expand Down Expand Up @@ -32,7 +32,7 @@ export class StackController {
return this.views.find(vw => vw.url === activatedUrlKey);
}

async setActive(enteringView: RouteView, direction: number, animated: boolean) {
async setActive(enteringView: RouteView, direction: NavDirection, animated: boolean) {
const leavingView = this.getActive();
this.insertView(enteringView, direction);
await this.transition(enteringView, leavingView, direction, animated, this.canGoBack(1), false);
Expand All @@ -54,7 +54,7 @@ export class StackController {
this.transition(
this.views[this.views.length - 2], // entering view
this.views[this.views.length - 1], // leaving view
-1,
'back',
true,
true,
true
Expand All @@ -69,15 +69,15 @@ export class StackController {
}


private insertView(enteringView: RouteView, direction: number) {
private insertView(enteringView: RouteView, direction: NavDirection) {
// no stack
if (!this.stack) {
this.views = [enteringView];
return;
}

// stack setRoot
if (direction === 0) {
if (direction === 'root') {
this.views = [enteringView];
return;
}
Expand All @@ -87,7 +87,7 @@ export class StackController {
if (index >= 0) {
this.views = this.views.slice(0, index + 1);
} else {
if (direction === 1) {
if (direction === 'forward') {
this.views.push(enteringView);
} else {
this.views = [enteringView];
Expand Down Expand Up @@ -120,7 +120,7 @@ export class StackController {
private async transition(
enteringView: RouteView | undefined,
leavingView: RouteView | undefined,
direction: number,
direction: NavDirection,
animated: boolean,
showGoBack: boolean,
progressAnimation: boolean
Expand All @@ -145,7 +145,7 @@ export class StackController {
await containerEl.componentOnReady();
this.runningTransition = containerEl.commit(enteringEl, leavingEl, {
duration: !animated ? 0 : undefined,
direction: direction === 1 ? 'forward' : 'back',
direction: direction === 'forward' ? 'forward' : 'back', // TODO: refactor
deepWait: true,
showGoBack,
progressAnimation
Expand Down
7 changes: 3 additions & 4 deletions angular/src/directives/navigation/tabs-delegate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { NavController } from '../../providers';
})
export class TabsDelegate {

@ContentChildren(TabDelegate) tabs: QueryList<TabDelegate>;
@ContentChildren(TabDelegate) tabs!: QueryList<TabDelegate>;

constructor(
@Optional() private navCtrl: NavController,
Expand All @@ -23,9 +23,8 @@ export class TabsDelegate {
return tabDelegate ? tabDelegate.getLastUrl() : undefined;
}

@HostListener('ionTabButtonClick', ['$event'])
onTabbarClick(ev: any) {
const detail = ev.detail as TabButtonClickDetail;
@HostListener('ionTabButtonClick', ['$event.detail'])
onTabbarClick(detail: TabButtonClickDetail) {
const { tab, href, selected } = detail;
if (tab && href) {
const url = selected
Expand Down
6 changes: 3 additions & 3 deletions angular/src/directives/virtual-scroll/virtual-scroll.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ import { VirtualContext } from './virtual-utils';
})
export class VirtualScroll {

@ContentChild(VirtualItem) itmTmp: VirtualItem;
@ContentChild(VirtualHeader) hdrTmp: VirtualHeader;
@ContentChild(VirtualFooter) ftrTmp: VirtualFooter;
@ContentChild(VirtualItem) itmTmp!: VirtualItem;
@ContentChild(VirtualHeader) hdrTmp!: VirtualHeader;
@ContentChild(VirtualFooter) ftrTmp!: VirtualFooter;

constructor(
private el: ElementRef,
Expand Down
100 changes: 43 additions & 57 deletions angular/src/providers/nav-controller.ts
Original file line number Diff line number Diff line change
@@ -1,110 +1,96 @@
import { Injectable, Optional } from '@angular/core';
import { Injectable } from '@angular/core';
import { Location } from '@angular/common';
import { NavigationExtras, Router, UrlTree } from '@angular/router';
import { BackButtonEvent } from '@ionic/core';
import { NavigationExtras, NavigationStart, Router, UrlTree } from '@angular/router';
import { Platform } from './platform';

export const enum NavIntent {
Auto,
Forward,
Back,
Root
}
export type NavDirection = 'forward' | 'back' | 'root' | 'auto';

@Injectable()
export class NavController {

private intent: NavIntent = NavIntent.Root;
private animated = true;
private stack: string[] = [];
private direction: NavDirection = DEFAULT_DIRECTION;
private animated = DEFAULT_ANIMATED;
private guessDirection: NavDirection = 'root';
private lastNavId = -1;

constructor(
private location: Location,
@Optional() private router?: Router
private router: Router,
platform: Platform
) {
window && window.document.addEventListener('ionBackButton', (ev) => {
(ev as BackButtonEvent).detail.register(0, () => this.goBack());
// Subscribe to router events to detect direction
router.events.subscribe(ev => {
if (ev instanceof NavigationStart) {
const id = (ev.restoredState) ? ev.restoredState.navigationId : ev.id;
this.guessDirection = id < this.lastNavId ? 'back' : 'forward';
this.lastNavId = id;
}
});

// Subscribe to backButton events
platform.backButton.subscribeWithPriority(0, () => this.goBack());
}

navigateForward(url: string | UrlTree | any[], animated?: boolean, extras?: NavigationExtras) {
this.setIntent(NavIntent.Forward, animated);
this.setDirection('forward', animated);
if (Array.isArray(url)) {
return this.router!.navigate(url, extras);
return this.router.navigate(url, extras);
} else {
return this.router!.navigateByUrl(url, extras);
return this.router.navigateByUrl(url, extras);
}
}

navigateBack(url: string | UrlTree | any[], animated?: boolean, extras?: NavigationExtras) {
this.setIntent(NavIntent.Back, animated);
extras = { replaceUrl: true, ...extras };
this.setDirection('back', animated);
// extras = { replaceUrl: true, ...extras };
if (Array.isArray(url)) {
return this.router!.navigate(url, extras);
return this.router.navigate(url, extras);
} else {
return this.router!.navigateByUrl(url, extras);
return this.router.navigateByUrl(url, extras);
}
}

navigateRoot(url: string | UrlTree | any[], animated?: boolean, extras?: NavigationExtras) {
this.setIntent(NavIntent.Root, animated);
this.setDirection('root', animated);
if (Array.isArray(url)) {
return this.router!.navigate(url, extras);
return this.router.navigate(url, extras);
} else {
return this.router!.navigateByUrl(url, extras);
return this.router.navigateByUrl(url, extras);
}
}

goBack(animated?: boolean) {
this.setIntent(NavIntent.Back, animated);
this.setDirection('back', animated);
return this.location.back();
}

setIntent(intent: NavIntent, animated?: boolean) {
this.intent = intent;
setDirection(direction: NavDirection, animated?: boolean) {
this.direction = direction;
this.animated = (animated === undefined)
? intent !== NavIntent.Root
? direction !== 'root'
: animated;
}

consumeTransition() {
const guessDirection = this.guessDirection();

let direction = 0;
let direction: NavDirection = 'root';
let animated = false;

if (this.intent === NavIntent.Auto) {
direction = guessDirection;
animated = direction !== 0;
if (this.direction === 'auto') {
direction = this.guessDirection;
animated = direction !== 'root';
} else {
animated = this.animated;
direction = intentToDirection(this.intent);
direction = this.direction;
}
this.intent = NavIntent.Root;
this.animated = false;
this.direction = DEFAULT_DIRECTION;
this.animated = DEFAULT_ANIMATED;

return {
direction,
animated
};
}

private guessDirection() {
const index = this.stack.indexOf(document.location!.href);
if (index === -1) {
this.stack.push(document.location!.href);
return 1;
} else if (index < this.stack.length - 1) {
this.stack = this.stack.slice(0, index + 1);
return -1;
}
return 0;
}
}

function intentToDirection(intent: NavIntent): number {
switch (intent) {
case NavIntent.Forward: return 1;
case NavIntent.Back: return -1;
default: return 0;
}
}
const DEFAULT_DIRECTION = 'auto';
const DEFAULT_ANIMATED = false;

0 comments on commit 72bc025

Please sign in to comment.