editLink

API Documentation / RouterScrollBehavior

Interface: RouterScrollBehavior

Type of the scrollBehavior option that can be passed to createRouter.

Callable

▸ RouterScrollBehavior(to, from, savedPosition): Awaitable<false | void | ScrollPosition>

Name	Type	Description
`to`	`RouteLocationNormalized`	Route location where we are navigating to
`from`	`RouteLocationNormalizedLoaded`	Route location where we are navigating from
`savedPosition`	`null` \| `_ScrollPositionNormalized`	saved position if it exists, `null` otherwise

Awaitable<false | void | ScrollPosition>