Skip to content

API DocumentationDocs


API Documentation / useRoute

Function: useRoute()

useRoute<CurrentRouteName>(_currentRouteName?): GetRouteLocationNormalizedLoaded<CurrentRouteName>

Returns the current route location. Equivalent to using $route inside templates.

Type Parameters

CurrentRouteName extends string | symbol = string | symbol

Parameters

_currentRouteName?: CurrentRouteName

Returns

GetRouteLocationNormalizedLoaded<CurrentRouteName>

Released under the MIT License.