]> git.ipfire.org Git - thirdparty/vuejs/router.git/commitdiff
docs: fix new links
authorEduardo San Martin Morote <posva13@gmail.com>
Wed, 8 Nov 2023 13:06:18 +0000 (14:06 +0100)
committerEduardo San Martin Morote <posva13@gmail.com>
Wed, 8 Nov 2023 13:06:18 +0000 (14:06 +0100)
28 files changed:
packages/docs/api/index.md
packages/docs/api/interfaces/NavigationGuard.md
packages/docs/api/interfaces/NavigationGuardWithThis.md
packages/docs/api/interfaces/RouteLocationMatched.md
packages/docs/api/interfaces/RouteLocationNormalized.md
packages/docs/api/interfaces/RouteMeta.md
packages/docs/api/interfaces/RouteRecordBase.md
packages/docs/api/interfaces/RouteRecordMultipleViews.md
packages/docs/api/interfaces/RouteRecordMultipleViewsWithChildren.md
packages/docs/api/interfaces/RouteRecordNormalized.md
packages/docs/api/interfaces/RouteRecordRedirect.md
packages/docs/api/interfaces/RouteRecordSingleView.md
packages/docs/api/interfaces/RouteRecordSingleViewWithChildren.md
packages/docs/api/interfaces/Router.md
packages/docs/api/interfaces/RouterHistory.md
packages/docs/api/interfaces/RouterOptions.md
packages/docs/api/interfaces/RouterScrollBehavior.md
packages/docs/guide/advanced/dynamic-routing.md
packages/docs/guide/advanced/navigation-failures.md
packages/docs/guide/advanced/navigation-guards.md
packages/docs/guide/advanced/transitions.md
packages/docs/guide/essentials/dynamic-matching.md
packages/docs/guide/essentials/history-mode.md
packages/docs/guide/essentials/named-routes.md
packages/docs/guide/essentials/navigation.md
packages/docs/guide/index.md
packages/docs/guide/migration/index.md
packages/docs/package.json

index 599abf1e96e2436c7231ba29d9cb7f3d43640856..f52a63a3c58f68b8f7951ce682a2db3e562f454b 100644 (file)
@@ -42,7 +42,7 @@ API Documentation
 
 ### LocationQuery
 
-Ƭ **LocationQuery**: `Record`<`string`, `LocationQueryValue` \| `LocationQueryValue`[]\>
+Ƭ **LocationQuery**: `Record`\<`string`, `LocationQueryValue` \| `LocationQueryValue`[]\>
 
 Normalized query object that appears in [RouteLocationNormalized](interfaces/RouteLocationNormalized.md)
 
@@ -50,17 +50,17 @@ ___
 
 ### LocationQueryRaw
 
-Ƭ **LocationQueryRaw**: `Record`<`string` \| `number`, `LocationQueryValueRaw` \| `LocationQueryValueRaw`[]\>
+Ƭ **LocationQueryRaw**: `Record`\<`string` \| `number`, `LocationQueryValueRaw` \| `LocationQueryValueRaw`[]\>
 
 Loose [LocationQuery](index.md#LocationQuery) object that can be passed to functions like
-[push](interfaces/Router.md#push) and [replace](interfaces/Router.md#replace) or anywhere when creating a
+[Router.push](interfaces/Router.md#push) and [Router.replace](interfaces/Router.md#replace) or anywhere when creating a
 [RouteLocationRaw](index.md#RouteLocationRaw)
 
 ___
 
 ### PathParserOptions
 
-Ƭ **PathParserOptions**: `Pick`<`_PathParserOptions`, ``"end"`` \| ``"sensitive"`` \| ``"strict"``\>
+Ƭ **PathParserOptions**: `Pick`\<`_PathParserOptions`, ``"end"`` \| ``"sensitive"`` \| ``"strict"``\>
 
 ___
 
@@ -82,13 +82,13 @@ ___
 
 ### RouteParams
 
-Ƭ **RouteParams**: `Record`<`string`, `RouteParamValue` \| `RouteParamValue`[]\>
+Ƭ **RouteParams**: `Record`\<`string`, `RouteParamValue` \| `RouteParamValue`[]\>
 
 ___
 
 ### RouteParamsRaw
 
-Ƭ **RouteParamsRaw**: `Record`<`string`, `RouteParamValueRaw` \| `Exclude`<`RouteParamValueRaw`, ``null`` \| `undefined`\>[]\>
+Ƭ **RouteParamsRaw**: `Record`\<`string`, `RouteParamValueRaw` \| `Exclude`\<`RouteParamValueRaw`, ``null`` \| `undefined`\>[]\>
 
 ___
 
@@ -116,7 +116,7 @@ ___
 
 ### UseLinkOptions
 
-Ƭ **UseLinkOptions**: `VueUseOptions`<`RouterLinkOptions`\>
+Ƭ **UseLinkOptions**: `VueUseOptions`\<`RouterLinkOptions`\>
 
 ## Variables
 
@@ -130,14 +130,24 @@ ___
 
 ### RouterView
 
-• `Const` **RouterView**: () => { `$props`: `AllowedComponentProps` & `ComponentCustomProps` & `VNodeProps` & [`RouterViewProps`](interfaces/RouterViewProps.md) ; `$slots`: { `default?`: (`__namedParameters`: { `Component`: `VNode`<`RendererNode`, `RendererElement`, { `[key: string]`: `any`;  }\> ; `route`: [`RouteLocationNormalizedLoaded`](interfaces/RouteLocationNormalizedLoaded.md)  }) => `VNode`<`RendererNode`, `RendererElement`, { `[key: string]`: `any`;  }\>[]  }  }
+• `Const` **RouterView**: () => \{ `$props`: `AllowedComponentProps` & `ComponentCustomProps` & `VNodeProps` & [`RouterViewProps`](interfaces/RouterViewProps.md) ; `$slots`: \{ `default?`: (`__namedParameters`: \{ `Component`: `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`;  }\> ; `route`: [`RouteLocationNormalizedLoaded`](interfaces/RouteLocationNormalizedLoaded.md)  }) => `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`;  }\>[]  }  }
 
 #### Type declaration
 
-• **new RouterView**()
+• **new RouterView**(): `Object`
 
 Component to display the current route the user is at.
 
+##### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `$props` | `AllowedComponentProps` & `ComponentCustomProps` & `VNodeProps` & [`RouterViewProps`](interfaces/RouterViewProps.md) |
+| `$slots` | \{ `default?`: (`__namedParameters`: \{ `Component`: `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`;  }\> ; `route`: [`RouteLocationNormalizedLoaded`](interfaces/RouteLocationNormalizedLoaded.md)  }) => `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`;  }\>[]  } |
+| `$slots.default?` | (`__namedParameters`: \{ `Component`: `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`;  }\> ; `route`: [`RouteLocationNormalizedLoaded`](interfaces/RouteLocationNormalizedLoaded.md)  }) => `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`;  }\>[] |
+
 ___
 
 ### START\_LOCATION
@@ -308,7 +318,7 @@ ___
 
 ### loadRouteLocation
 
-▸ **loadRouteLocation**(`route`): `Promise`<[`RouteLocationNormalizedLoaded`](interfaces/RouteLocationNormalizedLoaded.md)\>
+▸ **loadRouteLocation**(`route`): `Promise`\<[`RouteLocationNormalizedLoaded`](interfaces/RouteLocationNormalizedLoaded.md)\>
 
 Ensures a route is loaded, so it can be passed as o prop to `<RouterView>`.
 
@@ -320,7 +330,7 @@ Ensures a route is loaded, so it can be passed as o prop to `<RouterView>`.
 
 #### Returns
 
-`Promise`<[`RouteLocationNormalizedLoaded`](interfaces/RouteLocationNormalizedLoaded.md)\>
+`Promise`\<[`RouteLocationNormalizedLoaded`](interfaces/RouteLocationNormalizedLoaded.md)\>
 
 ___
 
@@ -372,7 +382,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `props` | `VueUseOptions`<`RouterLinkOptions`\> |
+| `props` | `VueUseOptions`\<`RouterLinkOptions`\> |
 
 #### Returns
 
@@ -380,11 +390,11 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `href` | `ComputedRef`<`string`\> |
-| `isActive` | `ComputedRef`<`boolean`\> |
-| `isExactActive` | `ComputedRef`<`boolean`\> |
-| `navigate` | (`e`: `MouseEvent`) => `Promise`<`void` \| [`NavigationFailure`](interfaces/NavigationFailure.md)\> |
-| `route` | `ComputedRef`<[`RouteLocation`](interfaces/RouteLocation.md) & { `href`: `string`  }\> |
+| `href` | `ComputedRef`\<`string`\> |
+| `isActive` | `ComputedRef`\<`boolean`\> |
+| `isExactActive` | `ComputedRef`\<`boolean`\> |
+| `navigate` | (`e`: `MouseEvent`) => `Promise`\<`void` \| [`NavigationFailure`](interfaces/NavigationFailure.md)\> |
+| `route` | `ComputedRef`\<[`RouteLocation`](interfaces/RouteLocation.md) & \{ `href`: `string`  }\> |
 
 ___
 
index ab2c280933159515ece779ab36bfa5ac5508eb66..7a9a4865c5fda6a5c285e4aa7b90e827c6f54704 100644 (file)
@@ -13,7 +13,7 @@ Guards](/guide/advanced/navigation-guards.md).
 
 ### NavigationGuard
 
-▸ **NavigationGuard**(`to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>
+▸ **NavigationGuard**(`to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`\<`NavigationGuardReturn`\>
 
 #### Parameters
 
@@ -25,4 +25,4 @@ Guards](/guide/advanced/navigation-guards.md).
 
 #### Returns
 
-`NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>
+`NavigationGuardReturn` \| `Promise`\<`NavigationGuardReturn`\>
index dc8127fbbe9fd38f731a0c18ecf502ece740f481..4b4fae7b00f7a8d360d2e7ae8d9c3952f81e4f4d 100644 (file)
@@ -4,7 +4,7 @@ editLink: false
 
 [API Documentation](../index.md) / NavigationGuardWithThis
 
-# Interface: NavigationGuardWithThis<T\>
+# Interface: NavigationGuardWithThis\<T\>
 
 Navigation guard. See [Navigation
 Guards](/guide/advanced/navigation-guards.md).
@@ -19,7 +19,7 @@ Guards](/guide/advanced/navigation-guards.md).
 
 ### NavigationGuardWithThis
 
-▸ **NavigationGuardWithThis**(`this`, `to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>
+▸ **NavigationGuardWithThis**(`this`, `to`, `from`, `next`): `NavigationGuardReturn` \| `Promise`\<`NavigationGuardReturn`\>
 
 #### Parameters
 
@@ -32,4 +32,4 @@ Guards](/guide/advanced/navigation-guards.md).
 
 #### Returns
 
-`NavigationGuardReturn` \| `Promise`<`NavigationGuardReturn`\>
+`NavigationGuardReturn` \| `Promise`\<`NavigationGuardReturn`\>
index 55d6d33191d0ba18c336b3a6cee2dc2a5b35da37..cf649dd7347e3e893b292ef6b702295428bb7971 100644 (file)
@@ -31,7 +31,7 @@ ___
 
 ### beforeEnter
 
-• **beforeEnter**: `undefined` \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\>[]
+• **beforeEnter**: `undefined` \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[]
 
 Registered beforeEnter guards
 
@@ -55,7 +55,7 @@ ___
 
 ### components
 
-• **components**: `undefined` \| ``null`` \| `Record`<`string`, [`RouteComponent`](../index.md#RouteComponent)\>
+• **components**: `undefined` \| ``null`` \| `Record`\<`string`, [`RouteComponent`](../index.md#RouteComponent)\>
 
 Components to display when the URL matches this route. Allow using named views.
 
@@ -67,7 +67,7 @@ ___
 
 ### instances
 
-• **instances**: `Record`<`string`, `undefined` \| ``null`` \| `ComponentPublicInstance`\>
+• **instances**: `Record`\<`string`, `undefined` \| ``null`` \| `ComponentPublicInstance`\>
 
 Mounted route component instances
 Having the instances on the record mean beforeRouteUpdate and
@@ -122,7 +122,7 @@ ___
 
 ### props
 
-• **props**: `Record`<`string`, `_RouteRecordProps`\>
+• **props**: `Record`\<`string`, `_RouteRecordProps`\>
 
 Allow passing down params as props to the component rendered by
 `router-view`. Should be an object with the same keys as `components` or a
index 573380169aa6506c91dfa8a0bac3b1e1618935aa..43949a3bddca07819beefc78fb36896b72bd52d4 100644 (file)
@@ -7,7 +7,7 @@ editLink: false
 # Interface: RouteLocationNormalized
 
 Similar to [RouteLocation](RouteLocation.md) but its
-[matched](RouteLocationNormalized.md#matched) cannot contain redirect records
+[RouteLocationNormalized.matched](RouteLocationNormalized.md#matched) cannot contain redirect records
 
 ## Hierarchy
 
index 03555d7172c5a4a5558beac76d7649825c5ccc5d..5e6007b1087ce90797588b1645e94578bb0f76bd 100644 (file)
@@ -23,6 +23,6 @@ declare module 'vue-router' {
 
 ## Hierarchy
 
-- `Record`<`string` \| `number` \| `symbol`, `unknown`\>
+- `Record`\<`string` \| `number` \| `symbol`, `unknown`\>
 
   ↳ **`RouteMeta`**
index 37754cfa88516f5f7f7d1f217e419eabd3dbf920..f64004047198a749f25e79548464ccbf6f9a75b9 100644 (file)
@@ -38,7 +38,7 @@ ___
 
 ### beforeEnter
 
-• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\>[]
+• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[]
 
 Before Enter guard specific to this record. Note `beforeEnter` has no
 effect if the record has a `redirect` property.
@@ -102,7 +102,7 @@ ___
 
 ### props
 
-• `Optional` **props**: `_RouteRecordProps` \| `Record`<`string`, `_RouteRecordProps`\>
+• `Optional` **props**: `_RouteRecordProps` \| `Record`\<`string`, `_RouteRecordProps`\>
 
 Allow passing down params as props to the component rendered by `router-view`.
 
index 93f986c5bf781575a69ef27830d43cfa01d50ec6..2f5007aa50dde23a115bd32b92ea08bde3ae1b26 100644 (file)
@@ -32,7 +32,7 @@ ___
 
 ### beforeEnter
 
-• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\>[]
+• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[]
 
 Before Enter guard specific to this record. Note `beforeEnter` has no
 effect if the record has a `redirect` property.
@@ -63,7 +63,7 @@ ___
 
 ### components
 
-• **components**: `Record`<`string`, `RawRouteComponent`\>
+• **components**: `Record`\<`string`, `RawRouteComponent`\>
 
 Components to display when the URL matches this route. Allow using named views.
 
@@ -130,7 +130,7 @@ ___
 
 ### props
 
-• `Optional` **props**: `boolean` \| `Record`<`string`, `_RouteRecordProps`\>
+• `Optional` **props**: `boolean` \| `Record`\<`string`, `_RouteRecordProps`\>
 
 Allow passing down params as props to the component rendered by
 `router-view`. Should be an object with the same keys as `components` or a
index f7f2b23516f0d3fda580168e2448f9e6c99e8540..ddec0ecaf56fc1abf4335c6e59b5f076a76db5d9 100644 (file)
@@ -32,7 +32,7 @@ ___
 
 ### beforeEnter
 
-• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\>[]
+• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[]
 
 Before Enter guard specific to this record. Note `beforeEnter` has no
 effect if the record has a `redirect` property.
@@ -63,7 +63,7 @@ ___
 
 ### components
 
-• `Optional` **components**: ``null`` \| `Record`<`string`, `RawRouteComponent`\>
+• `Optional` **components**: ``null`` \| `Record`\<`string`, `RawRouteComponent`\>
 
 Components to display when the URL matches this route. Allow using named views.
 
@@ -130,7 +130,7 @@ ___
 
 ### props
 
-• `Optional` **props**: `boolean` \| `Record`<`string`, `_RouteRecordProps`\>
+• `Optional` **props**: `boolean` \| `Record`\<`string`, `_RouteRecordProps`\>
 
 Allow passing down params as props to the component rendered by
 `router-view`. Should be an object with the same keys as `components` or a
index fc7dbb891b0744fc4b7b0c0db10305fcf830f481..0107112b6c258fa8db4bdef7d58218c50a7bf8a5 100644 (file)
@@ -27,7 +27,7 @@ ___
 
 ### beforeEnter
 
-• **beforeEnter**: `undefined` \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\>[]
+• **beforeEnter**: `undefined` \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[]
 
 Registered beforeEnter guards
 
@@ -43,7 +43,7 @@ ___
 
 ### components
 
-• **components**: `undefined` \| ``null`` \| `Record`<`string`, `RawRouteComponent`\>
+• **components**: `undefined` \| ``null`` \| `Record`\<`string`, `RawRouteComponent`\>
 
 Components to display when the URL matches this route. Allow using named views.
 
@@ -51,7 +51,7 @@ ___
 
 ### instances
 
-• **instances**: `Record`<`string`, `undefined` \| ``null`` \| `ComponentPublicInstance`\>
+• **instances**: `Record`\<`string`, `undefined` \| ``null`` \| `ComponentPublicInstance`\>
 
 Mounted route component instances
 Having the instances on the record mean beforeRouteUpdate and
@@ -90,7 +90,7 @@ ___
 
 ### props
 
-• **props**: `Record`<`string`, `_RouteRecordProps`\>
+• **props**: `Record`\<`string`, `_RouteRecordProps`\>
 
 Allow passing down params as props to the component rendered by
 `router-view`. Should be an object with the same keys as `components` or a
index 5e1496f6c97013e2362c508b181bb71d31626067..2f471ddd3cb5cfc101aea44f1dd2caca2b5b186d 100644 (file)
@@ -33,7 +33,7 @@ ___
 
 ### beforeEnter
 
-• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\>[]
+• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[]
 
 Before Enter guard specific to this record. Note `beforeEnter` has no
 effect if the record has a `redirect` property.
index 3bbb68a6eb6864cd0237e86706a52a7c176cb46b..9a64196dc26392f103f49c27831f7f15e987d8d4 100644 (file)
@@ -32,7 +32,7 @@ ___
 
 ### beforeEnter
 
-• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\>[]
+• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[]
 
 Before Enter guard specific to this record. Note `beforeEnter` has no
 effect if the record has a `redirect` property.
index 67b490cf7efaa37b03f1459a599c2f16d9109fa3..2216c0d92ba5d236d1e3aaceefd8c949635e4ccb 100644 (file)
@@ -32,7 +32,7 @@ ___
 
 ### beforeEnter
 
-• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\>[]
+• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[]
 
 Before Enter guard specific to this record. Note `beforeEnter` has no
 effect if the record has a `redirect` property.
index ca15e504999c726671bd8422bce1e07dc6d05c5e..9d7d79933b8668346f2f32acf77645792ba5f2cf 100644 (file)
@@ -12,7 +12,7 @@ Router instance.
 
 ### currentRoute
 
-• `Readonly` **currentRoute**: `Ref`<[`RouteLocationNormalizedLoaded`](RouteLocationNormalizedLoaded.md)\>
+• `Readonly` **currentRoute**: `Ref`\<[`RouteLocationNormalizedLoaded`](RouteLocationNormalizedLoaded.md)\>
 
 Current [RouteLocationNormalized](RouteLocationNormalized.md)
 
@@ -159,7 +159,7 @@ function that removes the registered guard.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `guard` | [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> | navigation guard to add |
+| `guard` | [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> | navigation guard to add |
 
 #### Returns
 
@@ -189,7 +189,7 @@ registered guard.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `guard` | [`NavigationGuardWithThis`](NavigationGuardWithThis.md)<`undefined`\> | navigation guard to add |
+| `guard` | [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> | navigation guard to add |
 
 #### Returns
 
@@ -292,7 +292,7 @@ ___
 
 ### isReady
 
-▸ **isReady**(): `Promise`<`void`\>
+▸ **isReady**(): `Promise`\<`void`\>
 
 Returns a Promise that resolves when the router has completed the initial
 navigation, which means it has resolved all async enter hooks and async
@@ -306,7 +306,7 @@ picks it up from the URL.
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 ___
 
@@ -346,7 +346,7 @@ ___
 
 ### push
 
-▸ **push**(`to`): `Promise`<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\>
+▸ **push**(`to`): `Promise`\<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\>
 
 Programmatically navigate to a new URL by pushing an entry in the history
 stack.
@@ -359,7 +359,7 @@ stack.
 
 #### Returns
 
-`Promise`<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\>
+`Promise`\<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\>
 
 ___
 
@@ -383,7 +383,7 @@ ___
 
 ### replace
 
-▸ **replace**(`to`): `Promise`<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\>
+▸ **replace**(`to`): `Promise`\<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\>
 
 Programmatically navigate to a new URL by replacing the current entry in
 the history stack.
@@ -396,13 +396,13 @@ the history stack.
 
 #### Returns
 
-`Promise`<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\>
+`Promise`\<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\>
 
 ___
 
 ### resolve
 
-▸ **resolve**(`to`, `currentLocation?`): [`RouteLocation`](RouteLocation.md) & { `href`: `string`  }
+▸ **resolve**(`to`, `currentLocation?`): [`RouteLocation`](RouteLocation.md) & \{ `href`: `string`  }
 
 Returns the [normalized version](RouteLocation.md) of a
 [route location](../index.md#RouteLocationRaw). Also includes an `href` property
@@ -418,4 +418,4 @@ that includes any existing `base`. By default, the `currentLocation` used is
 
 #### Returns
 
-[`RouteLocation`](RouteLocation.md) & { `href`: `string`  }
+[`RouteLocation`](RouteLocation.md) & \{ `href`: `string`  }
index 6f9e248456ecab4d64a16d4e226300dbad674e88..a7fb4b017e32b8361a5023ee3d9e3b48fb80d627 100644 (file)
@@ -153,7 +153,7 @@ ___
 
 ▸ **replace**(`to`, `data?`): `void`
 
-Same as [push](RouterHistory.md#push) but performs a `history.replaceState`
+Same as [RouterHistory.push](RouterHistory.md#push) but performs a `history.replaceState`
 instead of `history.pushState`
 
 #### Parameters
index 43548e2c61f4616880f0b1f6bb2e9bdf37329e5b..039498275ebe86068dfd649caac4c2ced96521a0 100644 (file)
@@ -80,7 +80,7 @@ ___
 ▸ (`search`): [`LocationQuery`](../index.md#LocationQuery)
 
 Custom implementation to parse a query. See its counterpart,
-[stringifyQuery](RouterOptions.md#stringifyQuery).
+[RouterOptions.stringifyQuery](RouterOptions.md#stringifyQuery).
 
 ##### Parameters
 
index b85e077753c3f2f7002873064f08ccc2305413e1..049a72503d980e911bc5ad64f81268302e677c27 100644 (file)
@@ -12,7 +12,7 @@ Type of the `scrollBehavior` option that can be passed to `createRouter`.
 
 ### RouterScrollBehavior
 
-▸ **RouterScrollBehavior**(`to`, `from`, `savedPosition`): `Awaitable`<``false`` \| `void` \| `ScrollPosition`\>
+▸ **RouterScrollBehavior**(`to`, `from`, `savedPosition`): `Awaitable`\<``false`` \| `void` \| `ScrollPosition`\>
 
 #### Parameters
 
@@ -24,4 +24,4 @@ Type of the `scrollBehavior` option that can be passed to `createRouter`.
 
 #### Returns
 
-`Awaitable`<``false`` \| `void` \| `ScrollPosition`\>
+`Awaitable`\<``false`` \| `void` \| `ScrollPosition`\>
index 17fab1eaec83bdf3d8cfaacca5e410935fe14edc..a2ad81a79d329eb7e3801c577e55497e3c670aa3 100644 (file)
@@ -5,9 +5,9 @@
   title="Learn how to add routes at runtime"
 />
 
-Adding routes to your router is usually done via the [`routes` option](../../api/#routes) but in some situations, you might want to add or remove routes while the application is already running. Application with extensible interfaces like [Vue CLI UI](https://cli.vuejs.org/dev-guide/ui-api.html) can use this to make the application grow.
+Adding routes to your router is usually done via the `routes` option but in some situations, you might want to add or remove routes while the application is already running. Application with extensible interfaces like [Vue CLI UI](https://cli.vuejs.org/dev-guide/ui-api.html) can use this to make the application grow.
 
-## Adding Routes
+## Adding routes
 
 Dynamic routing is achieved mainly via two functions: `router.addRoute()` and `router.removeRoute()`. They **only** register a new route, meaning that if the newly added route matches the current location, it would require you to **manually navigate** with `router.push()` or `router.replace()` to display that new route. Let's take a look at an example:
 
@@ -36,7 +36,7 @@ router.replace(router.currentRoute.value.fullPath)
 
 Remember you can `await router.replace()` if you need to wait for the new route to be displayed.
 
-## Adding Routes inside navigation guards
+## Adding routes inside navigation guards
 
 If you decide to add or remove routes inside of a navigation guard, you should not call `router.replace()` but trigger a redirection by returning the new location:
 
@@ -111,5 +111,5 @@ router.addRoute({
 
 Vue Router gives you two functions to look at existing routes:
 
-- [`router.hasRoute()`](/api/interfaces/Router.md#Methods-hasRoute): check if a route exists
-- [`router.getRoutes()`](/api/interfaces/Router.md#Methods-getRoutes): get an array with all the route records.
+- [`router.hasRoute()`](/api/interfaces/Router.md#hasRoute): check if a route exists
+- [`router.getRoutes()`](/api/interfaces/Router.md#getRoutes): get an array with all the route records.
index cc76a38da58b7f00aa47f550cd2a12811b839197..139197a7acd777333418c4c2f2a2cf3c7605be87 100644 (file)
@@ -64,7 +64,7 @@ If you omit the second parameter: `isNavigationFailure(failure)`, it will only c
 
 ## Global navigation failures
 
-You can detect global navigation failures globally by using the [`router.afterEach()` navigation guard](./navigation-guards.md#global-after-hooks):
+You can detect global navigation failures globally by using the [`router.afterEach()` navigation guard](./navigation-guards.md#Global-After-Hooks):
 
 ```ts
 router.afterEach((to, from, failure) => {
index 65c2532f07e66ba6c2be05a16a0c2d6192cb2270..fbad80c3ab0729e3ed96774e03d94116971627eb 100644 (file)
@@ -25,13 +25,13 @@ Global before guards are called in creation order, whenever a navigation is trig
 
 Every guard function receives two arguments:
 
-- **`to`**: the target route location [in a normalized format](../../api/#routelocationnormalized) being navigated to.
-- **`from`**: the current route location [in a normalized format](../../api/#routelocationnormalized) being navigated away from.
+- **`to`**: the target route location [in a normalized format](../../api/interfaces/RouteLocationNormalized.md) being navigated to.
+- **`from`**: the current route location [in a normalized format](../../api/interfaces/RouteLocationNormalized.md) being navigated away from.
 
 And can optionally return any of the following values:
 
 - `false`: cancel the current navigation. If the browser URL was changed (either manually by the user or via back button), it will be reset to that of the `from` route.
-- A [Route Location](../../api/#routelocationraw): Redirect to a different location by passing a route location as if you were calling [`router.push()`](../../api/#push), which allows you to pass options like `replace: true` or `name: 'home'`. The current navigation is dropped and a new one is created with the same `from`.
+- A [Route Location](../../api/#RouteLocationRaw): Redirect to a different location by passing a route location as if you were calling `router.push()`, which allows you to pass options like `replace: true` or `name: 'home'`. The current navigation is dropped and a new one is created with the same `from`.
 
   ```js
   router.beforeEach(async (to, from) => {
@@ -47,7 +47,7 @@ And can optionally return any of the following values:
   })
   ```
 
-It's also possible to throw an `Error` if an unexpected situation was met. This will also cancel the navigation and call any callback registered via [`router.onError()`](../../api/#onerror).
+It's also possible to throw an `Error` if an unexpected situation was met. This will also cancel the navigation and call any callback registered via [`router.onError()`](../../api/interfaces/Router.md#onError).
 
 If nothing, `undefined` or `true` is returned, **the navigation is validated**, and the next navigation guard is called.
 
@@ -197,7 +197,7 @@ const routes = [
 ]
 ```
 
-Note it is possible to achieve a similar behavior by using [route meta fields](./meta.md) and [global navigation guards](#global-before-guards).
+Note it is possible to achieve a similar behavior by using [route meta fields](./meta.md) and global navigation guards.
 
 ## In-Component Guards
 
index cc3fe6c97e93b840a31b7c3c830f3ff1cfccea2f..f49c5ae9e2ba634c846a640e31a618f9c9aabb17 100644 (file)
@@ -58,7 +58,7 @@ It is also possible to determine the transition to use dynamically based on the
 </router-view>
 ```
 
-We can add an [after navigation hook](./navigation-guards.md#global-after-hooks) to dynamically add information to the `meta` field based on the depth of the route
+We can add an [after navigation hook](./navigation-guards.md#Global-After-Hooks) to dynamically add information to the `meta` field based on the depth of the route
 
 ```js
 router.afterEach((to, from) => {
index 61c730a3d55fcf30385c4f910ed8981457bfdaf1..f74ab649dd13d3d40595ea6b368739365fc02d36 100644 (file)
@@ -36,7 +36,7 @@ You can have multiple _params_ in the same route, and they will map to correspon
 | /users/:username               | /users/eduardo           | `{ username: 'eduardo' }`                |
 | /users/:username/posts/:postId | /users/eduardo/posts/123 | `{ username: 'eduardo', postId: '123' }` |
 
-In addition to `$route.params`, the `$route` object also exposes other useful information such as `$route.query` (if there is a query in the URL), `$route.hash`, etc. You can check out the full details in the [API Reference](../../api/#routelocationnormalized).
+In addition to `$route.params`, the `$route` object also exposes other useful information such as `$route.query` (if there is a query in the URL), `$route.hash`, etc. You can check out the full details in the [API Reference](../../api/interfaces/RouteLocationNormalized.md).
 
 A working demo of this example can be found [here](https://codesandbox.io/s/route-params-vue-router-examples-mlb14?from-embed&initialpath=%2Fusers%2Feduardo%2Fposts%2F1).
 
@@ -116,7 +116,7 @@ this.$router.push({
 })
 ```
 
-See more in the [repeated params](./route-matching-syntax.md#repeatable-params) section.
+See more in the [repeated params](./route-matching-syntax.md#Repeatable-params) section.
 
 If you are using [History mode](./history-mode.md), make sure to follow the instructions to correctly configure your server as well.
 
index bdcdc5d459a565887e171df2d548ab19a94992ce..11e9e9994df55514e91b5aab173ad1b886e1b26c 100644 (file)
@@ -64,7 +64,7 @@ While it's not recommended, you can use this mode inside Browser applications bu
 
 ## Example Server Configurations
 
-**Note**: The following examples assume you are serving your app from the root folder. If you deploy to a subfolder, you should use [the `publicPath` option of Vue CLI](https://cli.vuejs.org/config/#publicpath) and the related [`base` property of the router](../../api/#Functions-createWebHistory). You also need to adjust the examples below to use the subfolder instead of the root folder (e.g. replacing `RewriteBase /` with `RewriteBase /name-of-your-subfolder/`).
+**Note**: The following examples assume you are serving your app from the root folder. If you deploy to a subfolder, you should use [the `publicPath` option of Vue CLI](https://cli.vuejs.org/config/#publicpath) and the related [`base` property of the router](../../api/interfaces/Router.md#createWebHistory). You also need to adjust the examples below to use the subfolder instead of the root folder (e.g. replacing `RewriteBase /` with `RewriteBase /name-of-your-subfolder/`).
 
 ### Apache
 
index 883c5dd77b9d5e2f230fada78edd4943c1dbdcee..eb43626e0c5bccbab3b9eb2b1dcaf72848551e66 100644 (file)
@@ -40,4 +40,4 @@ In both cases, the router will navigate to the path `/user/erina`.
 
 Full example [here](https://github.com/vuejs/vue-router/blob/dev/examples/named-routes/app.js).
 
-Each name **must be unique** across all routes. If you add the same name to multiple routes, the router will only keep the last one. You can read more about this [in the Dynamic Routing](../advanced/dynamic-routing.md#removing-routes) section.
+Each name **must be unique** across all routes. If you add the same name to multiple routes, the router will only keep the last one. You can read more about this [in the Dynamic Routing](../advanced/dynamic-routing.md#Removing-routes) section.
index acb7fa36cda0dcd42c2a8be3e7dee1026d19ed68..602ebb6f7efee735cffdd43c66b856b95fa8165a 100644 (file)
@@ -56,7 +56,7 @@ router.push({ name: 'user', params: { username } }) // -> /user/eduardo
 router.push({ path: '/user', params: { username } }) // -> /user
 ```
 
-When specifying `params`, make sure to either provide a `string` or `number` (or an array of these for [repeatable params](./route-matching-syntax.md#repeatable-params)). **Any other type (like objects, booleans, etc) will be automatically stringified**. For [optional params](./route-matching-syntax.md#optional-parameters), you can provide an empty string (`""`) or `null` as the value to remove it.
+When specifying `params`, make sure to either provide a `string` or `number` (or an array of these for [repeatable params](./route-matching-syntax.md#Repeatable-params)). **Any other type (like objects, booleans, etc) will be automatically stringified**. For [optional params](./route-matching-syntax.md#Optional-parameters), you can provide an empty string (`""`) or `null` as the value to remove it.
 
 Since the prop `to` accepts the same kind of object as `router.push`, the exact same rules apply to both of them.
 
@@ -110,4 +110,4 @@ You may have noticed that `router.push`, `router.replace` and `router.go` are co
 
 Therefore, if you are already familiar with [Browser History APIs](https://developer.mozilla.org/en-US/docs/Web/API/History_API), manipulating history will feel familiar when using Vue Router.
 
-It is worth mentioning that Vue Router navigation methods (`push`, `replace`, `go`) work consistently no matter the kind of [`history` option](../../api/#history) is passed when creating the router instance.
+It is worth mentioning that Vue Router navigation methods (`push`, `replace`, `go`) work consistently no matter the `history` option passed when creating the router instance.
index 6003571cedd9a0b146f39d5e315a62d40607edbe..2d826e71ef9ba2b4af0eb25b54b7e8c301b5b061 100644 (file)
@@ -1,9 +1,8 @@
 # Getting Started
 
 <VueSchoolLink
-  href="https://vueschool.io/courses/vue-router-4-for-everyone"
-  title="Learn how to build powerful Single Page Applications with the Vue Router on Vue School"
->Watch a Free Vue Router Video Course</VueSchoolLink>
+href="https://vueschool.io/courses/vue-router-4-for-everyone"
+title="Learn how to build powerful Single Page Applications with the Vue Router on Vue School">Watch a Free Vue Router Video Course</VueSchoolLink>
 
 Creating a Single-page Application with Vue + Vue Router feels natural: with Vue.js, we are already composing our application with components. When adding Vue Router to the mix, all we need to do is map our components to the routes and let Vue Router know where to render them. Here's a basic example:
 
@@ -97,6 +96,6 @@ export default {
 }
 ```
 
-To access the router or the route inside the `setup` function, call the `useRouter` or `useRoute` functions. We will learn more about this in [the Composition API](./advanced/composition-api.md#accessing-the-router-and-current-route-inside-setup)
+To access the router or the route inside the `setup` function, call the `useRouter` or `useRoute` functions. We will learn more about this in [the Composition API](./advanced/composition-api.md#Accessing-the-Router-and-current-Route-inside-setup)
 
 Throughout the docs, we will often use the `router` instance. Keep in mind that `this.$router` is exactly the same as directly using the `router` instance created through `createRouter`. The reason we use `this.$router` is because we don't want to import the router in every single component that needs to manipulate routing.
index f806bf4c5f3ba37d1f84edd5b5b404a66263e33b..c4bcbd6243ca1d9afef7f3d2f7ef7d5643e99140 100644 (file)
@@ -210,7 +210,7 @@ The `exact` prop has been removed because the caveat it was fixing is no longer
 - Routes are now active based on the route records they represent instead of the generated route location objects and their `path`, `query`, and `hash` properties
 - Only the `path` section is matched, `query`, and `hash` aren't taken into account anymore
 
-If you wish to customize this behavior, e.g. take into account the `hash` section, you should use the [`v-slot` API](/guide/advanced/composition-api#uselink) to extend `<router-link>`.
+If you wish to customize this behavior, e.g. take into account the `hash` section, you should use the [`v-slot` API](/guide/advanced/composition-api#useLink) to extend `<router-link>`.
 
 **Reason**: See the [RFC about active matching](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0028-router-active-link.md#summary) changes for more details.
 
@@ -220,7 +220,7 @@ At the moment navigation guards in mixins are not supported. You can track its s
 
 ### Removal of `router.match` and changes to `router.resolve`
 
-Both `router.match`, and `router.resolve` have been merged together into `router.resolve` with a slightly different signature. [Refer to the API](/api/interfaces/Router.md#Methods-resolve) for more details.
+Both `router.match`, and `router.resolve` have been merged together into `router.resolve` with a slightly different signature. [Refer to the API](/api/interfaces/Router.md#resolve) for more details.
 
 **Reason**: Uniting multiple methods that were used for the same purpose.
 
@@ -437,7 +437,7 @@ Decoded values in `params`, `query`, and `hash` are now consistent no matter whe
 Given any [normalized route location](/api/interfaces/RouteLocationNormalized.md):
 
 - Values in `path`, `fullPath` are not decoded anymore. They will appear as provided by the browser (most browsers provide them encoded). e.g. directly writing on the address bar `https://example.com/hello world` will yield the encoded version: `https://example.com/hello%20world` and both `path` and `fullPath` will be `/hello%20world`.
-- `hash` is now decoded, that way it can be copied over: `router.push({ hash: $route.hash })` and be used directly in [scrollBehavior](/api/interfaces/RouterOptions.md#Properties-scrollBehavior)'s `el` option.
+- `hash` is now decoded, that way it can be copied over: `router.push({ hash: $route.hash })` and be used directly in [scrollBehavior](/api/interfaces/RouterOptions.mdscrollBehavior)'s `el` option.
 - When using `push`, `resolve`, and `replace` and providing a `string` location or a `path` property in an object, **it must be encoded** (like in the previous version). On the other hand, `params`, `query` and `hash` must be provided in its unencoded version.
 - The slash character (`/`) is now properly decoded inside `params` while still producing an encoded version on the URL: `%2F`.
 
index 940f7f641fbb6ec70135553bcd6cb9a599b74938..c2392f1c9b0d99f20f578ad9ac60b81c43875210 100644 (file)
@@ -4,7 +4,7 @@
   "private": true,
   "scripts": {
     "docs": "vitepress dev .",
-    "docs:api": "node run-typedoc.js",
+    "docs:api": "node run-typedoc.mjs",
     "docs:build": "vitepress build ."
   },
   "dependencies": {