middleware

Nuxt provides a customizable route middleware framework you can use throughout your application, ideal for extracting code that you want to run before navigating to a particular route.

There are three kinds of route middleware:

1. Anonymous (or inline) route middleware are defined directly within the page.
2. Named route middleware, placed in the app/middleware/ and automatically loaded via asynchronous import when used on a page.
3. Global route middleware, placed in the app/middleware/ with a .global suffix and is run on every route change.

The first two kinds of route middleware can be defined in definePageMeta.

Usage

Route middleware are navigation guards that receive the current route and the next route as arguments.

export default defineNuxtRouteMiddleware((to, from) => {
  if (to.params.id === '1') {
    return abortNavigation()
  }
  // In a real app you would probably not redirect every route to `/`
  // however it is important to check `to.path` before redirecting or you
  // might get an infinite redirect loop
  if (to.path !== '/') {
    return navigateTo('/')
  }
})

Nuxt provides two globally available helpers that can be returned directly from the middleware.

1. navigateTo - Redirects to the given route
2. abortNavigation - Aborts the navigation, with an optional error message.

Unlike navigation guards from vue-router, a third next() argument is not passed, and redirect or route cancellation is handled by returning a value from the middleware.

Possible return values are:

• nothing (a simple return or no return at all) - does not block navigation and will move to the next middleware function, if any, or complete the route navigation
• return navigateTo('/') - redirects to the given path and will set the redirect code to 302 Found if the redirect happens on the server side
• return navigateTo('/', { redirectCode: 301 }) - redirects to the given path and will set the redirect code to 301 Moved Permanently if the redirect happens on the server side
• return abortNavigation() - stops the current navigation
• return abortNavigation(error) - rejects the current navigation with an error

Middleware Order

Middleware runs in the following order:

1. Global Middleware
2. Page defined middleware order (if there are multiple middleware declared with the array syntax)

For example, assuming you have the following middleware and component:

-| middleware/
---| analytics.global.ts
---| setup.global.ts
---| auth.ts

<script setup lang="ts">
definePageMeta({
  middleware: [
    function (to, from) {
      // Custom inline middleware
    },
    'auth',
  ],
});
</script>

You can expect the middleware to be run in the following order:

1. analytics.global.ts
2. setup.global.ts
3. Custom inline middleware
4. auth.ts

Ordering Global Middleware

By default, global middleware is executed alphabetically based on the filename.

However, there may be times you want to define a specific order. For example, in the last scenario, setup.global.ts may need to run before analytics.global.ts. In that case, we recommend prefixing global middleware with 'alphabetical' numbering.

-| middleware/
---| 01.setup.global.ts
---| 02.analytics.global.ts
---| auth.ts

When Middleware Runs

If your site is server-rendered or generated, middleware for the initial page will be executed both when the page is rendered and then again on the client. This might be needed if your middleware needs a browser environment, such as if you have a generated site, aggressively cache responses, or want to read a value from local storage.

However, if you want to avoid this behaviour you can do so:

export default defineNuxtRouteMiddleware(to => {
  // skip middleware on server
  if (import.meta.server) return
  // skip middleware on client side entirely
  if (import.meta.client) return
  // or only skip middleware on initial client load
  const nuxtApp = useNuxtApp()
  if (import.meta.client && nuxtApp.isHydrating && nuxtApp.payload.serverRendered) return
})

This is true even if you throw an error in your middleware on the server, and an error page is rendered. The middleware will still run again in the browser.

Accessing Route in Middleware

Always use the to and from parameters in your middleware to access the next and previous routes. Avoid using the useRoute() composable in this context altogether. There is no concept of a "current route" in middleware, as middleware can abort a navigation or redirect to a different route. The useRoute() composable will always be inaccurate in this context.

export default defineNuxtRouteMiddleware(to => {
  // passing the route to the function to avoid calling `useRoute()` in middleware
  doSomethingWithRoute(to)
    
  // ❌ this will output a warning and is NOT recommended
  callsRouteInternally()
})

// providing the route as an argument so that it can be used in middleware correctly
export function doSomethingWithRoute(route = useRoute()) {
  // ...
}

// ❌ this function is not suitable for use in middleware
export function callsRouteInternally() {
    const route = useRoute()
  // ...
}

Adding Middleware Dynamically

It is possible to add global or named route middleware manually using the addRouteMiddleware() helper function, such as from within a plugin.

export default defineNuxtPlugin(() => {
  addRouteMiddleware('global-test', () => {
    console.log('this global middleware was added in a plugin and will be run on every route change')
  }, { global: true })

  addRouteMiddleware('named-test', () => {
    console.log('this named middleware was added in a plugin and would override any existing middleware of the same name')
  })
})

Example

-| middleware/
---| auth.ts

In your page file, you can reference this route middleware:

<script setup lang="ts">
definePageMeta({
  middleware: ["auth"]
  // or middleware: 'auth'
})
</script>

Now, before navigation to that page can complete, the auth route middleware will be run.

Setting Middleware at Build Time

Instead of using definePageMeta on each page, you can add named route middleware within the pages:extend hook.

import type { NuxtPage } from 'nuxt/schema'

export default defineNuxtConfig({
  hooks: {
    'pages:extend' (pages) {
      function setMiddleware (pages: NuxtPage[]) {
        for (const page of pages) {
          if (/* some condition */ true) {
            page.meta ||= {}
            // Note that this will override any middleware set in `definePageMeta` in the page
            page.meta.middleware = ['named']
          }
          if (page.children) {
            setMiddleware(page.children)
          }
        }
      }
      setMiddleware(pages)
    }
  }
})