desconectar-vue-roteador

Roteamento automático baseado em arquivo em Vue com suporte TS

Demonstração StackBlitz

Este plugin de tempo de construção simplifica a configuração do roteamento e o torna mais seguro e fácil de usar graças ao TypeScript. Requer roteador Vue >=4.4.0.

Aviso

Embora o roteamento digitado unplugin-vue-router e o roteamento baseado em arquivo sejam fundamentalmente estáveis, ele contém outras APIs experimentais que estão sujeitas a alterações (por exemplo, carregadores de dados). Certifique-se de verificar a documentação relevante para obter as informações mais recentes. Se você encontrar algum problema, falha de design ou tiver ideias para melhorá-lo, por favor, abra um problema ou uma discussão.

Instalar

npm i -D unplugin-vue-router

Adicione o plugin VueRouter antes do plugin 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 ( ) ,
  ] ,
} )

Exemplo: playground/

Acúmulo

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

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

Webpack

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

CLI do Vue

 // 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 ( ) ] ,
} )

Configurar

Após a instalação, você deve executar seu servidor de desenvolvimento (geralmente npm run dev ) para gerar a primeira versão dos tipos . Então você precisa adicionar os tipos ao seu tsconfig.json .

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

Então, se você tiver um arquivo env.d.ts como aquele criado por npm vue create , adicione os tipos unplugin-vue-router/client a ele:

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

Se você não tiver um arquivo env.d.ts , poderá criar um e adicionar os tipos unplugin-vue-router a ele ou adicioná-los à propriedade types em seu tsconfig.json :

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

Por fim, importe as rotas geradas de vue-router/auto-routes e passe-as para o roteador:

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, você também pode importar o array routes e criar o roteador manualmente ou passá-lo para algum plugin. Aqui está um exemplo com o starter 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))
   },
 )