vue-router / RouterScrollBehavior

RouterScrollBehavior()

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

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

Parameters

to

RouteLocationNormalizedGeneric

Route location where we are navigating to

from

RouteLocationNormalizedLoadedGeneric

Route location where we are navigating from

savedPosition

saved position if it exists, null otherwise

null | _ScrollPositionNormalized

Returns

Awaitable<false | void | ScrollPosition>