kotlin-browser/web.navigation/NavigationDestination

NavigationDestination

open class NavigationDestination(source)

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

MDN Reference

Properties

val 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.

index

val index: Int53

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.

key

val 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.

sameDocument

val 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.

url

val url: String

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

Functions

getState

fun getState(): JsAny?

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.