File system based routing for Vue 3 applications using Vite

Install Pages:

$ npm install -D vite-plugin-pages

Add to your vite.config.js:

import Vue from '@vitejs/plugin-vue';
import Pages from 'vite-plugin-pages';

export default {
  plugins: [Vue(), Pages()],
};

By default a page is a Vue component exported from a .vue or .js file in the src/pages directory.

You can access the generated routes by importing the pages-generated module in your application.

import { createRouter } from 'vue-router';
import routes from 'pages-generated';

const router = createRouter({
  // ...
  routes,
});

If you want type definition of pages-generated, add vite-plugin-pages/client to compilerOptions.types of your tsconfig:

{
  "compilerOptions": {
    "types": ["vite-plugin-pages/client"]
  }
}

interface UserOptions {
  pagesDir?: string | string[] | PageDirOptions[]
  extensions?: string[]
  exclude: string[]
  importMode?: ImportMode | ImportModeResolveFn
  syncIndex?: boolean
  routeBlockLang: 'json5' | 'json' | 'yaml'
  extendRoute?: (route: Route, parent: Route | undefined) => Route | void
}

Relative path to the pages directory. Supports globs.

Can be:

• single path: routes point to /
• array of paths: all routes in the paths point to /
• array of PageDirOptions allowing you to specify base routes instead of /. See Feature Areas for more details

Default: 'src/pages'

Array of valid file extensions for pages.

Default: ['vue', 'js']

Import mode can be set to either async, sync, or a function which returns one of those values.

Default:

• Top level index file: 'sync', can turn off by option syncIndex.
• Others: 'async'

To get more fine-grained control over which routes are loaded sync/async, you can use a function to resolve the value based on the route path. For example:

// vite.config.js
export default {
  // ...
  plugins: [
    Pages({
      importMode(path) {
        // Load about page synchronously, all other pages are async.
        return path.includes('about') ? 'sync' : 'async';
      },
    }),
  ],
};

Default SFC route block parser.

Default: 'json5'

A function that takes a route and optionally returns a modified route. This is useful for augmenting your routes with extra data (e.g. route metadata).

// vite.config.js
export default {
  // ...
  plugins: [
    Pages({
      extendRoute(route, parent) {
        if (route.path === '/') {
          // Index is unauthenticated.
          return route;
        }

        // Augment the route with meta that indicates that the route requires authentication.
        return {
          ...route,
          meta: { auth: true },
        };
      },
    }),
  ],
};

To use custom configuration, pass your options to Pages when instantiating the plugin:

// vite.config.js
import Pages from 'vite-plugin-pages';

export default {
  plugins: [
    Pages({
      pagesDir: 'src/views',
      extensions: ['vue', 'ts'],
    }),
  ],
};

Add per-route information to the route by adding a <route> block to the SFC. Information here is directly added to the route after it is generated, and will override it.

You can specific a parser to use using <route lang="yaml">.

Supported parser: JSON, JSON5, YAML

Default: JSON5

JSON/JSON5:

<route>
{
  name: "name-override",
  meta: {
    requiresAuth: false
  }
}
</route>

YAML:

<route>
name: name-override
meta:
  requiresAuth: true
</route>

Specifying an array of PageDirOptions for pagesDir allow you to store pages anywhere in the source you'd like, and specify the base route to append to the path and the route name. This allows you to store your pages in feature areas.

Source structure:

src/features/
    -admin/
       -pages
       -components
       -code

In vite.config.js:

pagesDir: [
  { dir: 'src/pages', baseRoute: '' },
  { dir: 'src/features/admin/pages', baseRoute: 'admin' },
],