NavigateOptions type

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

type NavigateOptions = ToOptions & {
  replace?: boolean
  resetScroll?: boolean
  hashScrollIntoView?: boolean | ScrollIntoViewOptions
  viewTransition?: boolean | ViewTransitionOptions
  ignoreBlocker?: boolean
  reloadDocument?: boolean
  href?: string
}

type NavigateOptions = ToOptions & {
  replace?: boolean
  resetScroll?: boolean
  hashScrollIntoView?: boolean | ScrollIntoViewOptions
  viewTransition?: boolean | ViewTransitionOptions
  ignoreBlocker?: boolean
  reloadDocument?: boolean
  href?: string
}

The NavigateOptions object accepts the following properties:

• Type: boolean
• Optional
• Defaults to false.
• If true, the location will be committed to the browser history using history.replace instead of history.push.

• Type: boolean
• Optional
• 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.

• Type: boolean | ScrollIntoViewOptions
• Optional
• Defaults to true so the element with an id matching the hash will be scrolled into view after the location is committed to history.
• If false, the element with an id matching the hash will not be scrolled into view after the location is committed to history.
• If an object is provided, it will be passed to the scrollIntoView method as options.
• See MDN for more information on ScrollIntoViewOptions.

• Type: boolean | ViewTransitionOptions
• Optional
• Defaults to false.
• If true, navigation will be called using document.startViewTransition().
• 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.
• If the browser does not support this api, this option will be ignored.
• See MDN for more information on how this function works.
• See Google for more information on viewTransition types

• Type: boolean
• Optional
• Defaults to false.
• If true, navigation will ignore any blockers that might prevent it.

• Type: boolean
• Optional
• Defaults to false.
• If true, navigation to a route inside of router will trigger a full page load instead of the traditional SPA navigation.

• Type: string

• Optional

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

• ToOptions