过渡

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

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>

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

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

在页面之间导航时，这将产生以下结果

要为特定页面设置不同的过渡，请在页面的 definePageMeta 中设置 pageTransition 键

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

<template>
  <NuxtPage />
</template>

<style>
/* ... */
.rotate-enter-active,
.rotate-leave-active {
  transition: all 0.4s;
}
.rotate-enter-from,
.rotate-leave-to {
  opacity: 0;
  transform: rotate3d(1, 1, 1, 15deg);
}
</style>

跳转到关于页面时将添加 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>

<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>

全局设置

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

pageTransition 和 layoutTransition 键均接受TransitionPropsJSON 可序列化值，您可以在其中传入 name、mode 以及自定义 CSS 过渡的其他有效 transition 属性。

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>

禁用过渡

可以在特定路由上禁用 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 钩子为 Nuxt 页面创建高度动态且自定义的过渡。

这种方式非常适合 JavaScript 动画库，例如GSAP.

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>

了解更多关于JavaScript 钩子的详细信息，这些钩子在 Transition 组件中可用。

动态过渡

要使用条件逻辑应用动态过渡，您可以利用内联中间件将不同的过渡名称分配给 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 过渡，在前往上一个 ID 时应用 slide-right 过渡。

使用 NuxtPage 进行过渡

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

app/app.vue

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

请记住，此页面过渡不能通过各页面中的 definePageMeta 来覆盖。

视图过渡 API (实验性)

Nuxt 附带了实验性的视图过渡 API(参见MDN)。这是一种实现原生浏览器过渡的令人兴奋的新方式，它（除其他事项外）能够实现不同页面上无关元素之间的过渡。

您可以在 StackBlitz 上查看演示.

可以通过配置文件中的 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 选项时，逐页面覆盖视图过渡才会生效。

视图过渡类型

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

类型是在ViewTransition上设置的，可以使用:active-view-transition-type()伪类选择器在 CSS 中针对性地应用。

您可以在 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）来实现与新的视图过渡 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
})

已知问题

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

这有帮助吗？

报告问题或在 GitHub 上编辑此页面

SEO 和元数据

使用强大的 head 配置、组合式函数和组件改进您的 Nuxt 应用的 SEO。

数据获取

Nuxt 提供了用于处理应用内数据获取的组合式函数。