v4 (4.0.0)
Nuxt on GitHub

<NuxtLink>

源代码
Nuxt 提供了 <NuxtLink> 组件来处理应用内的各种链接。
<NuxtLink> 是 Vue Router 的 <RouterLink> 组件和 HTML <a> 标签的替代品。它能智能判断链接是 内部 还是 外部，并使用可用优化（预取、默认属性等）进行渲染。

内部路由

这个例子中，我们使用 <NuxtLink> 组件链接到应用的另一个页面。

<template>
  <NuxtLink to="/about">关于页面</NuxtLink>
</template>

向动态路由传递参数

这个例子中，我们传递 id 参数来链接到 ~/pages/posts/[id].vue 路由。

<template>
  <NuxtLink :to="{ name: 'posts-id', params: { id: 123 } }">
    文章 123
  </NuxtLink>
</template>
在 Nuxt DevTools 的 Pages 面板中查看路由名称及其可能接受的参数。
当向 to 属性传递对象时，<NuxtLink> 会继承 Vue Router 对查询参数的处理。键和值会自动编码，因此无需手动调用 encodeURI 或 encodeURIComponent。

处理静态文件和跨应用链接

默认情况下，<NuxtLink> 对相对路由使用 Vue Router 的客户端导航。当链接到 /public 目录中的静态文件或同一域下的其他应用时，可能会导致意外的 404 错误，因为它们不属于客户端路由。这种情况下，可以使用 <NuxtLink> 的 external 属性来绕过 Vue Router 的内部路由机制。

external 属性明确表示链接是外部的。<NuxtLink> 会将链接渲染为标准 HTML <a> 标签。这确保链接行为正确，绕过 Vue Router 的逻辑，直接指向资源。

链接到静态文件

对于 /public 目录中的静态文件（如 PDF 或图片），使用 external 属性确保链接正确解析。

pages/index.vue
<template>
  <NuxtLink to="/example-report.pdf" external>
    下载报告
  </NuxtLink>
</template>

链接到跨应用 URL

当指向同一域下的不同应用时，使用 external 属性确保正确行为。

pages/index.vue
<template>
  <NuxtLink to="/another-app" external>
    前往其他应用
  </NuxtLink>
</template>

使用 external 属性或依赖自动处理可确保正确导航，避免意外路由问题，并提高与静态资源或跨应用场景的兼容性。

外部路由

这个例子中，我们使用 <NuxtLink> 组件链接到一个网站。

app.vue
<template>
  <NuxtLink to="https://nuxtjs.org">
    Nuxt 官网
  </NuxtLink>
  <!-- <a href="https://nuxtjs.org" rel="noopener noreferrer">...</a> -->
</template>

rel 和 noRel 属性

默认情况下，带有 target 属性的链接或绝对链接（如以 http://、https:// 或 // 开头的链接）会应用 noopener noreferrer 的 rel 属性。

  • noopener 解决了旧浏览器中的安全漏洞。
  • noreferrer 通过不向链接站点发送 Referer 标头来提高用户隐私。

这些默认设置对 SEO 没有负面影响，被认为是最佳实践。

需要覆盖此行为时，可以使用 rel 或 noRel 属性。

app.vue
<template>
  <NuxtLink to="https://twitter.com/nuxt_js">
    Nuxt Twitter
  </NuxtLink>
  <!-- <a href="https://twitter.com/nuxt_js" rel="noopener noreferrer">...</a> -->

  <NuxtLink to="https://discord.nuxtjs.org" rel="noopener">
    Nuxt Discord
  </NuxtLink>
  <!-- <a href="https://discord.nuxtjs.org" rel="noopener">...</a> -->

  <NuxtLink to="/about" target="_blank">关于页面</NuxtLink>
  <!-- <a href="/about" target="_blank" rel="noopener noreferrer">...</a> -->
</template>

noRel 属性可用于阻止默认 rel 属性添加到绝对链接。

app.vue
<template>
  <NuxtLink to="https://github.com/nuxt" no-rel>
    Nuxt GitHub
  </NuxtLink>
  <!-- <a href="https://github.com/nuxt">...</a> -->
</template>
noRel 和 rel 不能同时使用。rel 会被忽略。

预取链接

Nuxt 自动包含智能预取功能。这意味着它会检测链接何时可见（默认情况下），无论是在视口中还是在滚动时，并预取这些页面的 JavaScript，以便用户点击链接时页面已准备就绪。Nuxt 仅在浏览器不忙时加载资源，并且如果您的连接处于离线状态或只有 2g 连接，则会跳过预取。

pages/index.vue
<NuxtLink to="/about" no-prefetch>不预取的关于页面</NuxtLink>
<NuxtLink to="/about" :prefetch="false">不预取的关于页面</NuxtLink>

自定义预取触发器

从 v3.13.0 开始，我们支持 <NuxtLink> 的自定义预取触发器。您可以使用 prefetchOn 属性来控制何时预取链接。

<template>
  <NuxtLink prefetch-on="visibility">
    当链接可见时预取（默认）
  </NuxtLink>

  <NuxtLink prefetch-on="interaction">
    当悬停或获得焦点时预取
  </NuxtLink>
</template>
  • visibility: 当链接在视口中可见时预取。使用 Intersection Observer API 监控元素与视口的交叉情况。当元素滚动到视图中时触发预取。
  • interaction: 当链接被悬停或聚焦时预取。此方法监听 pointerenter 和 focus 事件，在用户表示有意交互时主动预取资源。

您也可以使用对象来配置 prefetchOn：

<template>
  <NuxtLink :prefetch-on="{ interaction: true }">
    当悬停或获得焦点时预取
  </NuxtLink>
</template>

您可能不希望同时启用两者！

<template>
  <NuxtLink :prefetch-on="{ visibility: true, interaction: true }">
    当悬停/聚焦或可见时预取
  </NuxtLink>
</template>

此配置会观察元素何时进入视口，并监听 pointerenter 和 focus 事件。这可能会导致不必要的资源使用或冗余预取，因为不同条件下两种触发器可能会预取相同的资源。

启用跨域预取

要启用跨域预取，可以在 nuxt.config 中设置 crossOriginPrefetch 选项。这将使用 Speculation Rules API 启用跨域预取。

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

全局禁用预取

也可以为整个应用全局启用/禁用所有链接的预取。

nuxt.config.ts
export default defineNuxtConfig({
  experimental: {
    defaults: {
      nuxtLink: {
        prefetch: false,
      },
    },
  },
})

属性

RouterLink

当不使用 external 时，<NuxtLink> 支持所有 Vue Router 的 RouterLink 属性

NuxtLink

  • href: to 的别名。如果与 to 一起使用，href 将被忽略
  • noRel: 如果设置为 true，则不会向外部链接添加 rel 属性
  • external: 强制将链接渲染为 <a> 标签而不是 Vue Router 的 RouterLink。
  • prefetch: 启用时会预取视口中链接的中间件、布局和有效负载（使用 payloadExtraction 时）。由实验性的 crossOriginPrefetch 配置使用。
  • prefetchOn: 允许自定义控制何时预取链接。可能的选项是 interaction 和 visibility（默认）。您也可以传递一个对象进行完全控制，例如：{ interaction: true, visibility: true }。此属性仅在 prefetch 启用（默认）且未设置 noPrefetch 时使用。
  • noPrefetch: 禁用预取。
  • prefetchedClass: 应用于已预取链接的类。

Anchor

  • target: 应用于链接的 target 属性值
  • rel: 应用于链接的 rel 属性值。对于外部链接，默认为 "noopener noreferrer"。
可以覆盖默认值，参见 覆盖默认值 以了解更多。

覆盖默认值

在 Nuxt 配置中

您可以在 nuxt.config 中覆盖一些 <NuxtLink> 的默认值。

这些选项将来可能会移动到其他地方，例如 app.config 或 app/ 目录中。
nuxt.config.ts
export default defineNuxtConfig({
  experimental: {
    defaults: {
      nuxtLink: {
        // 默认值
        componentName: 'NuxtLink',
        externalRelAttribute: 'noopener noreferrer',
        activeClass: 'router-link-active',
        exactActiveClass: 'router-link-exact-active',
        prefetchedClass: undefined, // 可以是任何有效的字符串类名
        trailingSlash: undefined // 可以是 'append' 或 'remove'
        prefetch: true,
        prefetchOn: { visibility: true } 
      }
    }
  }
})

自定义链接组件

您可以通过使用 defineNuxtLink 创建自己的链接组件来覆盖 <NuxtLink> 的默认值。

components/MyNuxtLink.ts
export default defineNuxtLink({
  componentName: 'MyNuxtLink',
  /* 更多参数请参见下面的签名 */
})

然后您可以像往常一样使用 <MyNuxtLink /> 组件，并应用您的新默认值。

defineNuxtLink 签名

interface NuxtLinkOptions {
  componentName?: string;
  externalRelAttribute?: string;
  activeClass?: string;
  exactActiveClass?: string;
  trailingSlash?: 'append' | 'remove'
  prefetch?: boolean
  prefetchedClass?: string
  prefetchOn?: Partial<{
    visibility: boolean
    interaction: boolean
  }>
}
function defineNuxtLink(options: NuxtLinkOptions): Component {}
  • componentName: 组件名称。默认为 NuxtLink。
  • externalRelAttribute: 应用于外部链接的默认 rel 属性值。默认为 "noopener noreferrer"。设置为 "" 以禁用
  • activeClass: 应用于活动链接的默认类。与 Vue Router 的 linkActiveClass 选项 相同。默认为 Vue Router 的默认值（"router-link-active"）
  • exactActiveClass: 应用于精确活动链接的默认类。与 Vue Router 的 linkExactActiveClass 选项 相同。默认为 Vue Router 的默认值（"router-link-exact-active"）
  • trailingSlash: 用于在 href 中添加或删除尾部斜杠的选项。如果未设置或不匹配有效值 append 或 remove，则会被忽略。
  • prefetch: 是否默认预取链接。
  • prefetchOn: 默认应用哪些预取策略的精细控制。
  • prefetchedClass: 应用于已预取链接的默认类。
阅读并编辑实时示例中的内容 Docs > Examples > Routing > Pages.