setPageLayout

Dynamically change the layout of a page.

setPageLayout allows you to dynamically change the layout of a page. It relies on access to the Nuxt context and therefore can only be called within the Nuxt context.

Type Signature

function setPageLayout(layout: string, props?: Record<string, any>): void

Parameters

layout · string · required

The name of the layout to set for the current page.

props · Record<string, any>

Props to pass to the layout component.

Examples

Basic Usage

// app/middleware/custom-layout.ts
export default defineNuxtRouteMiddleware((to) => {
  // Set the layout on the route you are navigating _to_
  setPageLayout('other')
})

Passing Props to Layouts

You can pass props to the layout by providing an object as the second argument:

// app/middleware/admin-layout.ts
export default defineNuxtRouteMiddleware((to) => {
  setPageLayout('admin', {
    sidebar: true,
    title: 'Dashboard',
  })
})

The layout can then receive these props:

<!-- app/layouts/admin.vue -->
<script setup lang="ts">
const props = defineProps<{
  sidebar?: boolean
  title?: string
}>()
</script>

<template>
  <div>
    <aside v-if="sidebar">
      Sidebar
    </aside>
    <main>
      <h1>{{ title }}</h1>
      <slot />
    </main>
  </div>
</template>

Notes

If you choose to set the layout dynamically on the server side, you must do so before the layout is rendered by Vue (that is, within a plugin or route middleware) to avoid a hydration mismatch.

See Also

• Layouts Guide
• Route Middleware
• definePageMeta