v3.16
GitHub

过渡

使用 Vue 或原生浏览器视图过渡在页面和布局之间应用过渡效果。
Nuxt 利用 Vue 的 <Transition> 组件在页面和布局之间应用过渡效果。

页面过渡

您可以启用页面过渡，以对所有 页面 应用自动过渡效果。

nuxt.config.ts
export default defineNuxtConfig({
  app: {
    pageTransition: { name: 'page', mode: 'out-in' }
  },
})
如果您也在更改布局，则这里设置的页面过渡将不会运行。相反，您应该设置 布局过渡。

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

<template>
  <NuxtPage />
</template>

<style>
.page-enter-active,
.page-leave-active {
  transition: all 0.4s;
}
.page-enter-from,
.page-leave-to {
  opacity: 0;
  filter: blur(1rem);
}
</style>

在页面之间导航时，会产生如下效果：

要为某个页面设置不同的过渡效果，请在页面的 definePageMeta 中设置 pageTransition 键：

<script setup lang="ts">
definePageMeta({
  pageTransition: {
    name: 'rotate'
  }
})
</script>

导航到关于页面时将添加 3D 旋转效果：

布局过渡

您可以启用布局过渡，以对所有 布局 应用自动过渡效果。

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>

在页面之间导航时，会产生如下效果：

与 pageTransition 类似，您可以使用 definePageMeta 在页面组件上应用自定义 layoutTransition：

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

全局设置

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

pageTransition 和 layoutTransition 键都接受 TransitionProps 作为可序列化的 JSON 值，您可以在其中传递 name、mode 和其他有效的自定义 CSS 过渡的过渡属性。

nuxt.config.ts
export default defineNuxtConfig({
  app: {
    pageTransition: {
      name: 'fade',
      mode: 'out-in' // 默认
    },
    layoutTransition: {
      name: 'slide',
      mode: 'out-in' // 默认
    }
  }
})
如果您更改了 name 属性，您也必须相应地重命名 CSS 类。

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

pages/some-page.vue
<script setup lang="ts">
definePageMeta({
  pageTransition: {
    name: 'bounce',
    mode: 'out-in' // 默认
  }
})
</script>

禁用过渡

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 Hooks

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

这样做为 JavaScript 动画库（如 GSAP）提供了完美的用例。

pages/some-page.vue
<script setup lang="ts">
definePageMeta({
  pageTransition: {
    name: 'custom-flip',
    mode: 'out-in',
    onBeforeEnter: (el) => {
      console.log('进入之前...')
    },
    onEnter: (el, done) => {},
    onAfterEnter: (el) => {}
  }
})
</script>
了解更多关于 Transition 组件中可用的额外 JavaScript hooks。

动态过渡

要使用条件逻辑应用动态过渡，您可以利用内联 中间件 将不同的过渡名称分配给 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>

现在，当跳转到下一个 ID 时，将应用 slide-left 过渡，而跳转到之前的 ID 时将应用 slide-right：

使用 NuxtPage 的过渡

当在 app.vue 中使用 <NuxtPage /> 时，可以通过 transition 属性全局配置过渡以激活过渡效果。

app.vue
<template>
  <div>
    <NuxtLayout>
      <NuxtPage :transition="{
        name: 'bounce',
        mode: 'out-in'
      }" />
    </NuxtLayout>
  </div>
</template>
请记住，这种页面过渡不能通过个别页面上的 definePageMeta 覆盖。

视图过渡 API（实验性）

Nuxt 附带对 视图过渡 API 的实验性实现（参见 MDN）。这是一种实现原生浏览器过渡的新方法，它能够在不同页面之间过渡不相关的元素。

您可以在 https://nuxt-view-transitions.surge.sh 上查看演示，并在 StackBlitz 上查看源代码。

Nuxt 集成正在积极开发中，但可以通过在您的配置文件中启用 experimental.viewTransition 选项来激活：

nuxt.config.ts
export default defineNuxtConfig({
  experimental: {
    viewTransition: true
  }
})

可能的值为：false、true 或 'always'。

如果设置为 true，Nuxt 将不应用过渡，如果用户的浏览器匹配 prefers-reduced-motion: reduce（推荐）。如果设置为 always，Nuxt 将始终应用过渡，您需要遵循用户的偏好。

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

nuxt.config.ts
export default defineNuxtConfig({
  app: {
    // 在全局禁用视图过渡，并按页面选择
    viewTransition: false
  },
})

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

pages/about.vue
<script setup lang="ts">
definePageMeta({
  viewTransition: false
})
</script>
按页面基础覆盖视图过渡将只在您启用了 experimental.viewTransition 选项时生效。

如果您还使用 Vue 过渡如 pageTransition 和 layoutTransition（见上文）实现与新视图过渡 API 相同的效果，您可能希望在用户的浏览器支持更新的原生 web API 时 禁用 Vue 过渡。您可以通过创建 ~/middleware/disable-vue-transitions.global.ts，并包含以下内容来实现：

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

  // 禁用内置 Vue 过渡
  to.meta.pageTransition = false
  to.meta.layoutTransition = false
})

已知的问题

  • 如果您在页面设置函数中执行数据获取，您可能想要重新考虑是否在此时使用此功能。（按设计，视图过渡在进行时会完全冻结 DOM 更新。）我们会考虑将视图过渡限制在 <Suspense> 解析的最后时刻，但在此期间，如果这描述了您，可能需要仔细考虑是否采用此功能。