Cookies concent notice

This site uses cookies from Google to deliver its services and to analyze traffic.
Learn more
Skip to main content
Angular has a new websiteHead to Angular.devHome
/

This is the archived documentation for Angular v17. Please visit angular.dev to see this page for the current version of Angular.

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 implements OnDestroy {
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
getState(): unknown
historyGo(relativePosition: number = 0): void // inherited from common/LocationStrategy
abstract path(includeHash?: boolean): string
abstract prepareExternalUrl(internal: string): string
abstract getState(): unknown
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
historyGo(relativePosition: number)?: 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.

Further information is available in the Usage Notes...

Methods

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

void

      
      getBaseHref(): string
    
Parameters

There are no parameters.

Returns

string

      
      path(includeHash: boolean = false): string
    
Parameters
includeHash boolean

Optional. Default is false.

Returns

string

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

string

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

There are no parameters.

Returns

void

      
      back(): void
    
Parameters

There are no parameters.

Returns

void

      
      getState(): unknown
    
Parameters

There are no parameters.

Returns

unknown

      
      historyGo(relativePosition: number = 0): void
    
Parameters
relativePosition number

Optional. Default is 0.

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