Router Setup ​

By default, routes are loaded from the <project-root>/pages folder, where <project-root> refers to the root setting in your Vite configuration file.

The route paths are dynamically inferred from the directory structure, very much like Nuxt.js, and passed to the Vue Router instance in $app/create.js

Alternatively, you can also export a path constant from your route modules, in which case it will be used to override the dynamically inferred paths:

<template>
  <p>Route with path export</p>
</template>

<script>
export const path = '/my-page'
</script>

<template>
  <p>Route with path export</p>
</template>

<script>
export const path = '/my-page'
</script>

Routes location ​

Internally, the route modules location is set via the $app/routes.js virtual module, which is defined as follows by default:

export default import.meta.glob('/pages/**/*.vue')

export default import.meta.glob('/pages/**/*.vue')

To change the location where routes are loaded from, just place a routes.js file at your Vite project's root directory and @fastify/vue/plugin will automatically recognize it and use it instead.

Dynamic parameters ​

Dynamic route parameters uses [param] for a singular parameter and [param+] for wildcard routes.

Scroll behavior ​

Scroll behavior can be set by exporting the function scrollBehavior in root.vue. See Scroll Behavior on how to use it.

In your root.vue file:

export function scrollBehavior() {
  // Always scroll to the top
  return { top: 0, left: 0 };
}

export function scrollBehavior() {
  // Always scroll to the top
  return { top: 0, left: 0 };
}