Merge pull request #128 from victorgarciaesgi/feat/3.4.0

v3.4.0

README.md

@@ -60,8 +60,6 @@ Demo repo 🧪 : [nuxt-typed-router-demo](https://github.com/victorgarciaesgi/nu
 # Compatibility:
 
 - Nuxt 3
-- Nuxt 2 (via [`nuxt2` branch](https://github.com/victorgarciaesgi/nuxt-typed-router/tree/nuxt2))
-
 
 
 # Quick start
@@ -76,16 +74,6 @@ npm install -D nuxt-typed-router
 pnpm install -D nuxt-typed-router
 ```
 
-### Nuxt 2 legacy (not maintained)
-
-Nuxt 2 version is no longer maintained, but still available in [`nuxt2` branch](https://github.com/victorgarciaesgi/nuxt-typed-router/tree/nuxt2)
-It only has route name autocomplete functionnality
-
-```bash
-yarn add -D nuxt-typed-router@legacy
-# or
-npm install -D nuxt-typed-router@legacy
-```
 
 # Configuration
 Register the module in the `nuxt.config.ts`, done!

docs/content/2.usage/8.typing-components.md

@@ -0,0 +1,56 @@
+---
+title: Typing component props
+---
+
+# NuxtLink
+
+
+Sometimes you don't want to use `NuxtLink` directly and make a wrapper component, there is a way to do it with `nuxt-typed-router`. It implies using component generics if you're on a Vue SFC
+
+```vue
+<template>
+    <NuxtLink :to="props.to"></NuxtLink>
+</template>
+
+<script setup lang="ts" generic="T extends RoutesNamesList, P extends string">
+import type { RoutesNamesList, NuxtRoute } from '@typed-router';
+
+const props = defineProps<{
+  to: NuxtRoute<T, P>;
+}>();
+</script>
+```
+
+It's also easy to add support for `external` prop
+
+```vue
+<template>
+    <NuxtLink :to="props.to" :external='props.external'></NuxtLink>
+</template>
+
+<script setup lang="ts" generic="T extends RoutesNamesList, P extends string, E extends boolean = false">
+import type { RoutesNamesList, NuxtRoute } from '@typed-router';
+
+const props = defineProps<{
+  to: NuxtRoute<T, P>,
+  external?: E,
+}>();
+</script>
+```
+
+ ## Same behaviour for pure Typescript functions
+
+
+ ```ts
+import type { RoutesNamesList, NuxtRoute } from '@typed-router';
+
+export function myCustomNavigateTool<T extends RoutesNamesList, P extends string>(to: NuxtRoute<T, P>) {
+  //
+}
+
+```
+
+
+::alert{type="info"}
+There is also the same type variant if you use `@nuxtjs/i18n` : `NuxtLocaleRoute`
+::

docs/content/3.options/3.experimentalRemoveNuxtDefs.md → docs/content/3.options/3.removeNuxtDefs.md

@@ -1,8 +1,8 @@
 ---
-title: experimentalRemoveNuxtDefs
+title: removeNuxtDefs
 ---
 
-# experimentalRemoveNuxtDefs
+# removeNuxtDefs
 
 Remove Nuxt global definitions for `useRouter` etc.. to avoid conflicts
 ## Type

docs/content/3.options/4.experimentalIgnoreRoutes.md → docs/content/3.options/4.ignoreRoutes.md

@@ -1,16 +1,16 @@
 ---
-title: experimentalIgnoreRoutes
+title: ignoreRoutes
 ---
 
-# experimentalIgnoreRoutes
+# ignoreRoutes
 
 Allow to ignore selected files to be typed, for exemple 404 routes or catch-all routes.
 You can pass an array of file paths (taking base of your `pagesDir`).
 
 Usage:
 
 ```ts
-experimentalIgnoreRoutes: ["[...404].vue", "admin/[...slug].vue"];
+ignoreRoutes: ["[...404].vue", "admin/[...slug].vue"];
 ```
 
 ## Type

docs/package.json

@@ -10,6 +10,6 @@
   },
   "devDependencies": {
     "@nuxt-themes/docus": "1.14.3",
-    "nuxt": "^3.8.1"
+    "nuxt": "3.8.1"
   }
 }