Interface NavigationDestination

The NavigationDestination interface of the Navigation API represents the destination being navigated to in the current navigation.

MDN Reference

interface NavigationDestination {
    id: string;
    index: number;
    key: string;
    sameDocument: boolean;
    url: string;
    getState(): any;
}
Index
id index key sameDocument url
getState
id: string

The id read-only property of the NavigationDestination interface returns the id value of the destination NavigationHistoryEntry if the NavigateEvent.navigationType is traverse, or an empty string otherwise.

MDN Reference

index: number

The index read-only property of the NavigationDestination interface returns the index value of the destination NavigationHistoryEntry if the NavigateEvent.navigationType is traverse, or -1 otherwise.

MDN Reference

key: string

The key read-only property of the NavigationDestination interface returns the key value of the destination NavigationHistoryEntry if the NavigateEvent.navigationType is traverse, or an empty string otherwise.

MDN Reference

sameDocument: boolean

The sameDocument read-only property of the NavigationDestination interface returns true if the navigation is to the same document as the current Document value, or false otherwise.

MDN Reference

url: string

The url read-only property of the NavigationDestination interface returns the URL being navigated to.

MDN Reference

  • The getState() method of the NavigationDestination interface returns a clone of the developer-supplied state associated with the destination NavigationHistoryEntry, or navigation operation (e.g., navigate()) as appropriate.

    MDN Reference

    Returns any

Was this helpful?