The official Nuxt Certification Program in partnership with VueSchool is coming.

typed-router
typed-router

Provide autocompletion for pages route names and params

nuxt-typed-router cover

npm versionnpm downloadsnpm downloads

Provide a type safe router to Nuxt

  • Supports all programmatic navigation utils (NuxtLink, useRouter, navigateTo, useRoute, useLocalePath, etc...)
  • Supports optional params and catchAll routes
  • Autocompletes routes paths, names and params
  • Throw error if route path is invalid
  • Out of the box i18n support
  • Supports routes extended by config and modules



Documentation

Documentation

Play with it

Open in StackBlitz

Demo repo 🧪 : nuxt-typed-router-demo

Cool video about it from LearnVue!

Watch the video


Compatibility:

  • Nuxt 3

Quick start

For Nuxt 3

npx nuxi@latest module add typed-router

Configuration

Register the module in the nuxt.config.ts, done!

export default defineNuxtConfig({
  modules: ['nuxt-typed-router'],
});

Development

  1. Clone this repository
  2. Install dependencies using pnpm
  3. Build project for local tests pnpm run test
  4. Start dev playground pnpm run prepack && pnpm run dev
  5. Build project for deploy pnpm prepack

📑 License

MIT License