NavigateOptionProps

external interface NavigateOptionProps(source)

The NavigateOptions type is used to describe the options that can be used when describing a navigation action in TanStack Router. API Docs

Inheritors

Properties

Link copied to clipboard

If set to true, the router will scroll the element with an id matching the hash into view with default ScrollIntoViewOptions. If set to false, the router will not scroll the element with an id matching the hash into view. If set to ScrollIntoViewOptions, the router will scroll the element with an id matching the hash into view with the provided options.

Link copied to clipboard
abstract var href: String?

This can be used instead of to to navigate to a fully built href, e.g. pointing to an external target. API Docs

Link copied to clipboard
abstract var ignoreBlocker: Boolean?

If true, navigation will ignore any blockers that might prevent it.

Link copied to clipboard
abstract var reloadDocument: Boolean?

If true, navigation to a route inside of router will trigger a full page load instead of the traditional SPA navigation.

Link copied to clipboard
abstract var replace: Boolean?

replace is a boolean that determines whether the navigation should replace the current history entry or push a new one.

Link copied to clipboard
abstract var resetScroll: Boolean?

Defaults to true so that the scroll position will be reset to 0,0 after the location is committed to the browser history. If false, the scroll position will not be reset to 0,0 after the location is committed to history.

Link copied to clipboard

If set to true, the router will wrap the resulting navigation in a document.startViewTransition() call. If ViewTransitionOptions, route navigations will be called using document.startViewTransition({update, types}) where types will be the strings array passed with ViewTransitionOptions["types"]. If the browser does not support viewTransition types, the navigation will fall back to normal document.startTransition(), same as if true was passed.