Location

export class Location

exported from angular2/router defined in angular2/src/router/location.ts (line 3)

Location is a service that applications can use to interact with a browser's URL. Depending on which LocationStrategy is used, Location will either persist to the URL's path or the URL's hash segment.

Note: it's better to use Router service to trigger route changes. Use Location only if you need to interact with or create normalized URLs outside of routing.

Location is responsible for normalizing the URL against the application's base href. A normalized URL is absolute from the URL host, includes the application's base href, and has no trailing slash:

Example

import {Component} from 'angular2/core'; import { ROUTER_DIRECTIVES, ROUTER_PROVIDERS, RouteConfig, Location } from 'angular2/router'; @Component({directives: [ROUTER_DIRECTIVES]}) @RouteConfig([ {...}, ]) class AppCmp { constructor(location: Location) { location.go('/foo'); } } bootstrap(AppCmp, [ROUTER_PROVIDERS]);

Annotations

@Injectable()

Constructor

constructor(platformStrategy: LocationStrategy)

Not Yet Documented

Members

platformStrategy : LocationStrategy

Not Yet Documented

path() : string

Returns the normalized URL path.

normalize(url: string) : string

Given a string representing a URL, returns the normalized URL path without leading or trailing slashes

prepareExternalUrl(url: string) : string

Given a string representing a URL, returns the platform-specific external URL path. If the given URL doesn't begin with a leading slash ('/'), this method adds one before normalizing. This method will also add a hash if HashLocationStrategy is used, or the APP_BASE_HREF if the PathLocationStrategy is in use.

go(path: string, query?: string) : void

Changes the browsers URL to the normalized version of the given URL, and pushes a new item onto the platform's history.

replaceState(path: string, query?: string) : void

Changes the browsers URL to the normalized version of the given URL, and replaces the top item on the platform's history stack.

forward() : void

Navigates forward in the platform's history.

back() : void

Navigates back in the platform's history.

subscribe(onNext: (value: any) => void, onThrow?: (exception: any) => void, onReturn?: () => void) : Object

Subscribe to the platform's popState events.