Compositions: useLink()

const useLink: {
<TRouteKey>  (name, params?, options?): UseLink;
  (url, options?): UseLink;
  (resolvedRoute, options?): UseLink;
  (source, paramsOrOptions?, maybeOptions?): UseLink;
};

A composition to export much of the functionality that drives RouterLink component. Also exports some useful context about routes relationship to current URL and convenience methods for navigating.

Call Signature

<TRouteKey>(
   name, 
   params?, 
   options?): UseLink;

Type Parameters

Type Parameter
TRouteKey extends unknown

Parameters

Parameter	Type
name	MaybeRefOrGetter<TRouteKey>
params?	MaybeRefOrGetter< | Record<string, unknown> | { [x: string]: unknown; [x: number]: unknown; [x: symbol]: unknown; }>
options?	MaybeRefOrGetter<UseLinkOptions>

Returns

UseLink

Call Signature

(url, options?): UseLink;

Parameters

Parameter	Type
url	MaybeRefOrGetter<Url>
options?	MaybeRefOrGetter<UseLinkOptions>

Returns

UseLink

Call Signature

(resolvedRoute, options?): UseLink;

Parameters

Parameter	Type
resolvedRoute	MaybeRefOrGetter< | undefined | Readonly<{ hash: string; href: Url; id: TRoute["id"]; matched: TRoute["matched"]; matches: TRoute["matches"]; name: TRoute["name"]; params: ExtractRouteParamTypesReading<TRoute>; query: URLSearchParams; state: ExtractRouteStateParamsAsOptional<TRoute["state"]>; }>>
options?	MaybeRefOrGetter<UseLinkOptions>

Returns

UseLink

Call Signature

(
   source, 
   paramsOrOptions?, 
   maybeOptions?): UseLink;

Parameters

Parameter	Type
source	MaybeRefOrGetter< | undefined | string | Readonly<{ hash: string; href: Url; id: TRoute["id"]; matched: TRoute["matched"]; matches: TRoute["matches"]; name: TRoute["name"]; params: ExtractRouteParamTypesReading<TRoute>; query: URLSearchParams; state: ExtractRouteStateParamsAsOptional<TRoute["state"]>; }>>
paramsOrOptions?	MaybeRefOrGetter< | UseLinkOptions | Record<PropertyKey, unknown>>
maybeOptions?	MaybeRefOrGetter<UseLinkOptions>

Returns

UseLink

Param

The name of the route or a valid URL.

Param

If providing route name, this argument will expect corresponding params.

Param

RouterResolveOptions Same options as router resolve.

Returns

Reactive context values for as well as navigation methods.