Configuration ​

Have a glimpse of all the existing configuration options with their corresponding default values:

routesDir ​

• Type: string
• Default: 'src/routes'

The directory which will be processed to auto-generate your application routes.

vueRoutes({
  routesDir: 'src/routes', // e.g., 'pages'.
});

vueRoutes({
  routesDir: 'src/routes', // e.g., 'pages'.
});

layoutsDir ​

• Type: string
• Default: 'src/layouts'

The layouts directory, each file of which will be auto-registered as a layout.

vueRoutes({
  layoutsDir: 'src/layouts', // e.g., 'layouts'.
});

vueRoutes({
  layoutsDir: 'src/layouts', // e.g., 'layouts'.
});

middlewareDir ​

• Type: string
• Default: 'src/middleware'

The middleware directory, each file of which will be auto-registered as a middleware.

vueRoutes({
  middlewareDir: 'src/middleware', // e.g., 'middleware'.
});

vueRoutes({
  middlewareDir: 'src/middleware', // e.g., 'middleware'.
});

routeFile ​

• Type: string
• Default: 'Registry.vue'

A special Registry.vue file is used to make route segments publicly accessible.

vueRoutes({
  routeFile: 'Registry.vue', // e.g., 'page.vue'.
});

vueRoutes({
  routeFile: 'Registry.vue', // e.g., 'page.vue'.
});

routeMacro ​

• Type: string
• Default: 'defineRegistry'

A special defineRegistry macro is used to make route segments publicly accessible.

vueRoutes({
  routeMacro: 'defineRegistry', // e.g., 'definePage'.
});

vueRoutes({
  routeMacro: 'defineRegistry', // e.g., 'definePage'.
});