过渡

使用 Vue 或浏览器原生的 View Transitions，在页面和布局之间应用过渡效果。

Nuxt 利用 Vue 的 <Transition> 组件来在页面和布局之间应用过渡效果。

由于 Nuxt 使用 Vue 的 <Transition> 组件，你想要添加动画的页面或布局必须只有一个根元素。拥有多个根元素（fragment）的页面或布局无法被添加动画，因此过渡不会运行，并且在路由之间导航时可能会报错。Nuxt 会在开发环境下对此发出警告。请将模板包裹在单一根元素中（例如一个 <div>）。

布局过渡（Layout Transitions）

你可以启用布局过渡，为所有布局应用自动过渡。

nuxt.config.ts

export default defineNuxtConfig({
  app: {
    layoutTransition: { name: 'layout', mode: 'out-in' },
  },
})

要开始在你的页面和布局之间添加过渡，请将以下 CSS 添加到你的 app.vue：

<template>
  <NuxtLayout>
    <NuxtPage />
  </NuxtLayout>
</template>

<style>
.layout-enter-active,
.layout-leave-active {
  transition: all 0.4s;
}
.layout-enter-from,
.layout-leave-to {
  filter: grayscale(1);
}
</style>

<template>
  <div>
    <pre>default layout</pre>
    <slot />
  </div>
</template>

<style scoped>
div {
  background-color: lightgreen;
}
</style>

<template>
  <div>
    <pre>orange layout</pre>
    <slot />
  </div>
</template>

<style scoped>
div {
  background-color: #eebb90;
  padding: 20px;
  height: 100vh;
}
</style>

<template>
  <div>
    <h1>Home page</h1>
    <NuxtLink to="/about">About page</NuxtLink>
  </div>
</template>

<script setup lang="ts">
definePageMeta({
  layout: 'orange',
})
</script>

<template>
  <div>
    <h1>About page</h1>
    <NuxtLink to="/">Home page</NuxtLink>
  </div>
</template>

在页面之间导航时，会产生以下结果：

与 pageTransition 类似，你可以使用 definePageMeta 为页面组件应用自定义的 layoutTransition：

pages/about.vue

<script setup lang="ts">
definePageMeta({
  layout: 'orange',
  layoutTransition: {
    name: 'slide-in',
  },
})
</script>

全局设置（Global Settings）

你可以使用 nuxt.config 全局自定义这些默认的过渡名称。

pageTransition 和 layoutTransition 这两个键都接受 TransitionProps 作为 JSON 可序列化的值，你可以向其中传递 name、mode 和自定义 CSS 过渡的其他有效 transition props。

nuxt.config.ts

export default defineNuxtConfig({
  app: {
    pageTransition: {
      name: 'fade',
      mode: 'out-in', // default
    },
    layoutTransition: {
      name: 'slide',
      mode: 'out-in', // default
    },
  },
})

如果你更改了 name 属性，也必须相应地重命名 CSS 类。

要覆盖全局过渡属性，请使用 definePageMeta 为单个 Nuxt 页面定义页面或布局过渡，并覆盖在 nuxt.config 文件中全局定义的任何页面或布局过渡。

pages/some-page.vue

<script setup lang="ts">
definePageMeta({
  pageTransition: {
    name: 'bounce',
    mode: 'out-in', // default
  },
})
</script>

禁用过渡（Disable Transitions）

pageTransition 和 layoutTransition 可以针对特定路由被禁用：

pages/some-page.vue

<script setup lang="ts">
definePageMeta({
  pageTransition: false,
  layoutTransition: false,
})
</script>

或者在 nuxt.config 中全局禁用：

nuxt.config.ts

export default defineNuxtConfig({
  app: {
    pageTransition: false,
    layoutTransition: false,
  },
})

JavaScript 钩子（JavaScript Hooks）

对于高级用例，你可以使用 JavaScript 钩子为你的 Nuxt 页面创建高度动态和自定义的过渡。

这种方式非常适合 GSAP 等 JavaScript 动画库的使用场景。

pages/some-page.vue

<script setup lang="ts">
definePageMeta({
  pageTransition: {
    name: 'custom-flip',
    mode: 'out-in',
    onBeforeEnter: (el) => {
      console.log('Before enter...')
    },
    onEnter: (el, done) => {},
    onAfterEnter: (el) => {},
  },
})
</script>

了解更多 Transition 组件中可用的JavaScript 钩子。

动态过渡（Dynamic Transitions）

要应用使用条件逻辑的动态过渡，你可以利用内联 middleware 来为 to.meta.pageTransition 分配不同的过渡名称。

<script setup lang="ts">
definePageMeta({
  pageTransition: {
    name: 'slide-right',
    mode: 'out-in',
  },
  middleware (to, from) {
    if (to.meta.pageTransition && typeof to.meta.pageTransition !== 'boolean') {
      to.meta.pageTransition.name = +to.params.id! > +from.params.id! ? 'slide-left' : 'slide-right'
    }
  },
})
</script>

<template>
  <h1>#{{ $route.params.id }}</h1>
</template>

<style>
.slide-left-enter-active,
.slide-left-leave-active,
.slide-right-enter-active,
.slide-right-leave-active {
  transition: all 0.2s;
}
.slide-left-enter-from {
  opacity: 0;
  transform: translate(50px, 0);
}
.slide-left-leave-to {
  opacity: 0;
  transform: translate(-50px, 0);
}
.slide-right-enter-from {
  opacity: 0;
  transform: translate(-50px, 0);
}
.slide-right-leave-to {
  opacity: 0;
  transform: translate(50px, 0);
}
</style>

<script setup lang="ts">
const route = useRoute()
const id = computed(() => Number(route.params.id || 1))
const prev = computed(() => '/' + (id.value - 1))
const next = computed(() => '/' + (id.value + 1))
</script>

<template>
  <div>
    <slot />
    <div v-if="$route.params.id">
      <NuxtLink :to="prev">⬅️</NuxtLink> |
      <NuxtLink :to="next">➡️</NuxtLink>
    </div>
  </div>
</template>

现在页面在前往下一个 id 时应用 slide-left 过渡，在返回上一个时应用 slide-right：

配合 NuxtPage 的过渡（Transition with NuxtPage）

当 <NuxtPage /> 在 app.vue 中使用时，可以通过 transition 属性配置过渡，从而全局启用过渡。

app/app.vue

<template>
  <div>
    <NuxtLayout>
      <NuxtPage
        :transition="{
          name: 'bounce',
          mode: 'out-in',
        }"
      />
    </NuxtLayout>
  </div>
</template>

注意，这种页面过渡无法被单个页面上的 definePageMeta 覆盖。

View Transitions API（实验性）

Nuxt 附带了一个实验性的 View Transitions API 实现（参见 MDN）。这是一种令人兴奋的新方式，可以实现浏览器原生的过渡，其中（除其他能力外）能够跨不同页面上的不相关元素进行过渡。

你可以在 StackBlitz 上查看一个 demo。

可以通过配置文件中的 experimental.viewTransition 选项来启用 Nuxt 的集成：

nuxt.config.ts

export default defineNuxtConfig({
  experimental: {
    viewTransition: true,
  },
})

可选值为：false、true 或 'always'。

如果设置为 true，当用户的浏览器匹配 prefers-reduced-motion: reduce 时，Nuxt 不会应用过渡（推荐）。如果设置为 always，Nuxt 将始终应用过渡，是否尊重用户偏好由你自己决定。

默认情况下，视图过渡对所有页面启用，但你可以设置一个不同的全局默认值。

nuxt.config.ts

export default defineNuxtConfig({
  app: {
    // Disable view transitions globally, and opt-in on a per page basis
    viewTransition: false,
  },
})

可以通过在页面的 definePageMeta 中设置 viewTransition 键来覆盖该页面的默认 viewTransition 值：

pages/about.vue

<script setup lang="ts">
definePageMeta({
  viewTransition: false,
})
</script>

基于每个页面覆盖视图过渡，只有在你启用了 experimental.viewTransition 选项时才会生效。

视图过渡类型（View Transition Types） v4.4

视图过渡类型允许你根据导航的类型应用不同的 CSS 动画。这对于创建非对称过渡（例如，向前导航与向后导航时使用不同的动画）很有用。

类型被设置在 ViewTransition 上，并可以在 CSS 中使用 :active-view-transition-type() 伪类选择器来定位。

你可以在 nuxt.config.ts 中全局设置默认类型：

nuxt.config.ts

export default defineNuxtConfig({
  app: {
    viewTransition: {
      enabled: true,
      types: ['slide'],
    },
  },
})

或者使用 definePageMeta 按页面配置类型。按页面的类型同时支持静态数组和函数，以实现动态行为：

pages/detail.vue

<script setup lang="ts">
definePageMeta({
  viewTransition: {
    enabled: true,
    // Types applied to any transition involving this page
    types: ['slide'],
    // Types applied only when navigating TO this page
    toTypes: ['slide-in'],
    // Types applied only when navigating FROM this page
    fromTypes: ['slide-out'],
  },
})
</script>

你也可以在 definePageMeta 中为 types、toTypes 和 fromTypes 使用函数，以根据路由动态决定类型：

pages/[id].vue

<script setup lang="ts">
definePageMeta({
  viewTransition: {
    enabled: true,
    toTypes: (to, from) => {
      // Slide left when going to a higher ID, right otherwise
      return Number(to.params.id) > Number(from.params.id)
        ? ['slide-left']
        : ['slide-right']
    },
  },
})
</script>

然后在你的 CSS 中定位这些类型：

/* Default crossfade */
::view-transition-old(root),
::view-transition-new(root) {
  animation-duration: 0.3s;
}

/* Slide left animation */
html:active-view-transition-type(slide-left) {
  &::view-transition-old(root) {
    animation: slide-out-left 0.3s ease-in-out;
  }
  &::view-transition-new(root) {
    animation: slide-in-right 0.3s ease-in-out;
  }
}

/* Slide right animation */
html:active-view-transition-type(slide-right) {
  &::view-transition-old(root) {
    animation: slide-out-right 0.3s ease-in-out;
  }
  &::view-transition-new(root) {
    animation: slide-in-left 0.3s ease-in-out;
  }
}

types、toTypes 和 fromTypes 的函数值只能在 definePageMeta 中使用，而不能在 nuxt.config.ts 中使用（那里只支持静态 string[]）。

page:view-transition:start 钩子提供了对 ViewTransition 对象的访问，其中包含可以在运行时读取或修改的 types 属性（ViewTransitionTypeSet）：

plugins/view-transition.client.ts

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('page:view-transition:start', (transition) => {
    // Read or modify types at runtime
    console.log([...transition.types])
  })
})

如果你同时使用 Vue 过渡（如 pageTransition 和 layoutTransition，见上文）来实现与新的 View Transitions API 相同的效果，那么你可能希望在用户的浏览器支持这个更新的原生 Web API 时_禁用_ Vue 过渡。可以通过创建 ~/middleware/disable-vue-transitions.global.ts 并填入以下内容来实现：

export default defineNuxtRouteMiddleware((to) => {
  if (import.meta.server || !document.startViewTransition) {
    return
  }

  // Disable built-in Vue transitions
  to.meta.pageTransition = false
  to.meta.layoutTransition = false
})

已知问题（Known Issues）

如果你在页面的 setup 函数中执行数据获取，目前可能希望暂时不要使用这个功能。（根据设计，View Transitions 在进行期间会完全冻结 DOM 更新。）我们正在考虑将 View Transition 限制在 <Suspense> 解析之前的最后时刻，但在此期间，如果你属于这种情况，可能需要仔细考虑是否采用该功能。