Skip to content

API Documentation / RouterScrollBehavior

Interface: RouterScrollBehavior

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

Callable

RouterScrollBehavior

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

Parameters

NameTypeDescription
toRouteLocationNormalizedGenericRoute location where we are navigating to
fromRouteLocationNormalizedLoadedGenericRoute location where we are navigating from
savedPositionnull | _ScrollPositionNormalizedsaved position if it exists, null otherwise

Returns

Awaitable<false | void | ScrollPosition>

Released under the MIT License.