RedirectOptions

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.

The HTTP headers to use when redirecting.

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

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.

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

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.

The HTTP status code to use when redirecting.

If provided, will throw the redirect object instead of returning it. This can be useful in places where throwing in a function might cause it to have a return type of never. In that case, you can use redirect({ throw: true }) to throw the redirect object instead of returning it.

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.