NavigateOptionProps
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
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.
If true, navigation will ignore any blockers that might prevent it.
If true, navigation to a route inside of router will trigger a full page load instead of the traditional SPA navigation.
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.
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.