PathLocationStrategy
A LocationStrategy
used to configure the Location
service to
represent its state in the
path of the
browser's URL.
class PathLocationStrategy extends LocationStrategy implements OnDestroy {
onPopState(fn: LocationChangeListener): void
getBaseHref(): string
prepareExternalUrl(internal: string): string
path(includeHash: boolean = false): string
pushState(state: any, title: string, url: string, queryParams: string)
replaceState(state: any, title: string, url: 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
}
Provided in
-
'root'
Description
If you're using PathLocationStrategy
, you may provide a APP_BASE_HREF
or add a <base href>
element to the document to override the default.
For instance, if you provide an APP_BASE_HREF
of '/my/app/'
and call
location.go('/foo')
, the browser's URL will become
example.com/my/app/foo
. To ensure all relative URIs resolve correctly,
the <base href>
and/or APP_BASE_HREF
should end with a /
.
Similarly, if you add <base href='/my/app/'/>
to the document and call
location.go('/foo')
, the browser's URL will become
example.com/my/app/foo
.
Note that when using PathLocationStrategy
, neither the query nor
the fragment in the <base href>
will be preserved, as outlined
by the RFC.
Further information is available in the Usage Notes...
Methods
onPopState() |
---|
getBaseHref() |
---|
ParametersThere are no parameters. Returns
|
prepareExternalUrl() |
---|
path() |
---|
pushState() |
---|
replaceState() |
---|
forward() |
---|
ParametersThere are no parameters. Returns
|
back() |
---|
ParametersThere are no parameters. Returns
|
getState() |
---|
ParametersThere are no parameters. Returns
|
historyGo() |
---|
Usage notes
Example
import {Location, LocationStrategy, PathLocationStrategy} from '@angular/common';
import {Component} from '@angular/core';
@Component({
selector: 'path-location',
providers: [Location, {provide: LocationStrategy, useClass: PathLocationStrategy}],
template: `
<h1>PathLocationStrategy</h1>
Current URL is: <code>{{ location.path() }}</code
><br />
Normalize: <code>/foo/bar/</code> is: <code>{{ location.normalize('foo/bar') }}</code
><br />
`,
})
export class PathLocationComponent {
location: Location;
constructor(location: Location) {
this.location = location;
}
}