HashLocationStrategy

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

See more...

class HashLocationStrategy extends LocationStrategy {
  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.

Methods

onPopState()
onPopState(fn: LocationChangeListener): void Parameters fn LocationChangeListener Returns void

getBaseHref()
getBaseHref(): string Parameters There are no parameters. Returns string

path()
path(includeHash: boolean = false): string Parameters includeHash boolean Optional. Default is false. Returns string

prepareExternalUrl()
prepareExternalUrl(internal: string): string Parameters internal string Returns string

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

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

forward()
forward(): void Parameters There are no parameters. Returns void

back()
back(): void Parameters There are no parameters. Returns void

Usage notes

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; }
}