Skip to content

API DocumentationDocs


API Documentation / _RouterLinkI

Interface: _RouterLinkI

Internal

Typed version of the RouterLink component. Its generic defaults to the typed router, so it can be inferred automatically for JSX.

Constructors

new _RouterLinkI()

new _RouterLinkI(): object

Returns

object

$props

$props: AllowedComponentProps & ComponentCustomProps & VNodeProps & RouterLinkProps

$slots

$slots: object

$slots.default()?

optional default: (__namedParameters) => VNode<RendererNode, RendererElement, object>[]

Parameters

__namedParameters

__namedParameters.href: string

__namedParameters.isActive: boolean

__namedParameters.isExactActive: boolean

__namedParameters.route: RouteLocationResolvedGeneric

__namedParameters.navigate

Returns

VNode<RendererNode, RendererElement, object>[]

Properties

useLink: <Name>(props) => UseLinkReturn<Name>

Internal

Access to useLink() without depending on using vue-router

Returns the internal behavior of a RouterLink without the rendering part.

Type Parameters

Name extends string | symbol = string | symbol

Parameters

props: UseLinkOptions<Name>

a to location and an optional replace flag

Returns

UseLinkReturn<Name>

Released under the MIT License.