desconectar-vue-enrutador

Enrutamiento automático basado en archivos en Vue con soporte TS

Demostración de StackBlitz

Este complemento en tiempo de compilación simplifica la configuración de enrutamiento y lo hace más seguro y fácil de usar gracias a TypeScript. Requiere enrutador Vue >=4.4.0.

Advertencia

Si bien el enrutamiento tipo unplugin-vue-router y el enrutamiento basado en archivos son fundamentalmente estables, contiene otras API experimentales que están sujetas a cambios (por ejemplo, cargadores de datos). Asegúrese de consultar la documentación relevante para obtener la información más reciente. Si encuentra algún problema, defecto de diseño o tiene ideas para mejorarlo, abra un problema o una discusión.

Instalar

npm i -D unplugin-vue-router

Agregue el complemento VueRouter antes del complemento Vue:

vite

 // vite.config.ts
import VueRouter from 'unplugin-vue-router/vite'

export default defineConfig ( {
  plugins : [
    VueRouter ( {
      /* options */
    } ) ,
    // ️ Vue must be placed after VueRouter()
    Vue ( ) ,
  ] ,
} )

Ejemplo: playground/

resumen

 // rollup.config.js
import VueRouter from 'unplugin-vue-router/rollup'

export default {
  plugins : [
    VueRouter ( {
      /* options */
    } ) ,
    // ️ Vue must be placed after VueRouter()
    Vue ( ) ,
  ] ,
}

paquete web

 // webpack.config.js
module . exports = {
  /* ... */
  plugins : [
    require ( 'unplugin-vue-router/webpack' ) ( {
      /* options */
    } ) ,
  ] ,
}

Vista CLI

 // vue.config.js
module . exports = {
  configureWebpack : {
    plugins : [
      require ( 'unplugin-vue-router/webpack' ) ( {
        /* options */
      } ) ,
    ] ,
  } ,
}

construir

 // esbuild.config.js
import { build } from 'esbuild'
import VueRouter from 'unplugin-vue-router/esbuild'

build ( {
  plugins : [ VueRouter ( ) ] ,
} )

Configuración

Después de la instalación, debe ejecutar su servidor de desarrollo (generalmente npm run dev ) para generar la primera versión de los tipos . Luego necesitas agregar los tipos a tu tsconfig.json .

{
  "include" : [
    // ...
    " ./typed-router.d.ts "
  ],
  // ...
  "compilerOptions" : {
    // ...
    "moduleResolution" : " Bundler "
    // ...
  }
}

Luego, si tiene un archivo env.d.ts como el creado por npm vue create , agréguele los tipos unplugin-vue-router/client :

 // env.d.ts
/// 
///

Si no tiene un archivo env.d.ts , puede crear uno y agregarle los tipos unplugin-vue-router o puede agregarlos a la propiedad types en su tsconfig.json :

{
  "compilerOptions" : {
    // ...
    "types" : [ " unplugin-vue-router/client " ]
  }
}

Finalmente, importe las rutas generadas desde vue-router/auto-routes y páselas al enrutador:

import { createRouter, createWebHistory } from 'vue-router'
+ import { routes } from 'vue-router/auto-routes'

createRouter({
  history: createWebHistory(),
  // pass the generated routes written by the plugin ?
+  routes,
})

Alternativamente, también puedes importar la matriz routes y crear el enrutador manualmente o pasarlo a algún complemento. Aquí hay un ejemplo con el iniciador Vitesse:

 import { ViteSSG } from 'vite-ssg'
 import { setupLayouts } from 'virtual:generated-layouts'
 import App from './App.vue'
 import type { UserModule } from './types'
- import generatedRoutes from '~pages'
+ import { routes } from 'vue-router/auto-routes'

 import '@unocss/reset/tailwind.css'
 import './styles/main.css'
 import 'uno.css'

- const routes = setupLayouts(generatedRoutes)

 // https://github.com/antfu/vite-ssg
 export const createApp = ViteSSG(
   App,
   {
-   routes,
+   routes: setupLayouts(routes),
    base: import.meta.env.BASE_URL
  },
   (ctx) => {
     // install all modules under `modules/`
     Object.values(import.meta.glob<{ install: UserModule }>('./modules/*.ts', { eager: true }))
       .forEach(i => i.install?.(ctx))
   },
 )