W3cubDocs

/Angular

HashLocationStrategy

class stable

A LocationStrategy used to configure the Location service to represent its state in the hash fragment of the browser's URL.

class HashLocationStrategy extends LocationStrategy {
  constructor(_platformLocation: PlatformLocation, _baseHref?: string)
  onPopState(fn: LocationChangeListener): void
  getBaseHref(): string
  path(includeHash: boolean = false): string
  prepareExternalUrl(internal: string): string
  pushState(state: any, title: string, path: string, queryParams: string)
  replaceState(state: any, title: string, path: string, queryParams: string)
  forward(): void
  back(): void

  // inherited from common/LocationStrategy
  abstract path(includeHash?: boolean): string
  abstract prepareExternalUrl(internal: string): string
  abstract pushState(state: any, title: string, url: string, queryParams: string): void
  abstract replaceState(state: any, title: string, url: string, queryParams: string): void
  abstract forward(): void
  abstract back(): void
  abstract onPopState(fn: LocationChangeListener): void
  abstract getBaseHref(): string
}

Description

For instance, if you call location.go('/foo'), the browser's URL will become example.com#/foo.

Example

import {HashLocationStrategy, Location, LocationStrategy} from '@angular/common';
import {Component} from '@angular/core';

@Component({
  selector: 'hash-location',
  providers: [Location, {provide: LocationStrategy, useClass: HashLocationStrategy}],
  template: `
    <h1>HashLocationStrategy</h1>
    Current URL is: <code>{{location.path()}}</code><br>
    Normalize: <code>/foo/bar/</code> is: <code>{{location.normalize('foo/bar')}}</code><br>
  `
})
export class HashLocationComponent {
  location: Location;
  constructor(location: Location) { this.location = location; }
}

Constructor

constructor(_platformLocation: PlatformLocation, _baseHref?: string)

Parameters

_platformLocation

Type: PlatformLocation.

_baseHref

Type: string.

Optional. Default is undefined.

Methods

onPopState()

onPopState(fn: LocationChangeListener): void

Parameters

fn

Type: LocationChangeListener.

Returns

void

getBaseHref()

getBaseHref(): string

Parameters

There are no parameters.

Returns

string

path()

path(includeHash: boolean = false): string

Parameters

includeHash

Type: boolean.

Optional. Default is false.

Returns

string

prepareExternalUrl()

prepareExternalUrl(internal: string): string

Parameters

internal

Type: string.

Returns

string

pushState()

pushState(state: any, title: string, path: string, queryParams: string)

Parameters

state

Type: any.

title

Type: string.

path

Type: string.

queryParams

Type: string.

replaceState()

replaceState(state: any, title: string, path: string, queryParams: string)

Parameters

state

Type: any.

title

Type: string.

path

Type: string.

queryParams

Type: string.

forward()

forward(): void

Parameters

There are no parameters.

Returns

void

back()

back(): void

Parameters

There are no parameters.

Returns

void

Annotations

@Injectable()

© 2010–2018 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/api/common/HashLocationStrategy