b44b14368f
Previously there wasn't a way to retrieve `history.state` from the `Location` service. The only time the framework exposed this value was in navigation events. This meant if you weren't using the Angular router, there wasn't a way to get access to this `history.state` value other than going directly to the DOM. This PR adds an API to retrieve the value of `history.state`. This will be useful and needed to provide a backwards-compatible `Location` service that can emulate AngularJS's `$location` service since we will need to be able to read the state data in order to produce AngularJS location transition events. This feature will additionally be useful to any application that wants to access state data through Angular rather than going directly to the DOM APIs. PR Close #30055
94 lines
2.7 KiB
TypeScript
94 lines
2.7 KiB
TypeScript
/**
|
|
* @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 {EventEmitter, Injectable} from '@angular/core';
|
|
|
|
|
|
|
|
/**
|
|
* A mock implementation of {@link LocationStrategy} that allows tests to fire simulated
|
|
* location events.
|
|
*
|
|
* @publicApi
|
|
*/
|
|
@Injectable()
|
|
export class MockLocationStrategy extends LocationStrategy {
|
|
internalBaseHref: string = '/';
|
|
internalPath: string = '/';
|
|
internalTitle: string = '';
|
|
urlChanges: string[] = [];
|
|
/** @internal */
|
|
_subject: EventEmitter<any> = new EventEmitter();
|
|
private stateChanges: any[] = [];
|
|
constructor() { super(); }
|
|
|
|
simulatePopState(url: string): void {
|
|
this.internalPath = url;
|
|
this._subject.emit(new _MockPopStateEvent(this.path()));
|
|
}
|
|
|
|
path(includeHash: boolean = false): string { return this.internalPath; }
|
|
|
|
prepareExternalUrl(internal: string): string {
|
|
if (internal.startsWith('/') && this.internalBaseHref.endsWith('/')) {
|
|
return this.internalBaseHref + internal.substring(1);
|
|
}
|
|
return this.internalBaseHref + internal;
|
|
}
|
|
|
|
pushState(ctx: any, title: string, path: string, query: string): void {
|
|
// Add state change to changes array
|
|
this.stateChanges.push(ctx);
|
|
|
|
this.internalTitle = title;
|
|
|
|
const url = path + (query.length > 0 ? ('?' + query) : '');
|
|
this.internalPath = url;
|
|
|
|
const externalUrl = this.prepareExternalUrl(url);
|
|
this.urlChanges.push(externalUrl);
|
|
}
|
|
|
|
replaceState(ctx: any, title: string, path: string, query: string): void {
|
|
// Reset the last index of stateChanges to the ctx (state) object
|
|
this.stateChanges[(this.stateChanges.length || 1) - 1] = ctx;
|
|
|
|
this.internalTitle = title;
|
|
|
|
const url = path + (query.length > 0 ? ('?' + query) : '');
|
|
this.internalPath = url;
|
|
|
|
const externalUrl = this.prepareExternalUrl(url);
|
|
this.urlChanges.push('replace: ' + externalUrl);
|
|
}
|
|
|
|
onPopState(fn: (value: any) => void): void { this._subject.subscribe({next: fn}); }
|
|
|
|
getBaseHref(): string { return this.internalBaseHref; }
|
|
|
|
back(): void {
|
|
if (this.urlChanges.length > 0) {
|
|
this.urlChanges.pop();
|
|
this.stateChanges.pop();
|
|
const nextUrl = this.urlChanges.length > 0 ? this.urlChanges[this.urlChanges.length - 1] : '';
|
|
this.simulatePopState(nextUrl);
|
|
}
|
|
}
|
|
|
|
forward(): void { throw 'not implemented'; }
|
|
|
|
getState(): unknown { return this.stateChanges[(this.stateChanges.length || 1) - 1]; }
|
|
}
|
|
|
|
class _MockPopStateEvent {
|
|
pop: boolean = true;
|
|
type: string = 'popstate';
|
|
constructor(public newUrl: string) {}
|
|
}
|