navigateTo

源文件
navigateTo 是一个用于以编程方式导航用户的辅助函数。

使用

navigateTo 可在服务端和客户端使用。它可以在 Nuxt 上下文 中使用，也可以直接调用以执行页面导航。

在调用 navigateTo 时，请确保始终对其结果使用 await 或 return。
navigateTo 不能在 Nitro 路由中使用。若要在 Nitro 路由中执行服务端重定向，请使用sendRedirect代替。

在 Vue 组件中使用

<script setup lang="ts">
// passing 'to' as a string
await navigateTo('/search')

// ... or as a route object
await navigateTo({ path: '/search' })

// ... or as a route object with query parameters
await navigateTo({
  path: '/search',
  query: {
    page: 1,
    sort: 'asc',
  },
})
</script>

在路由中间件中使用

export default defineNuxtRouteMiddleware((to, from) => {
  if (to.path !== '/search') {
    // setting the redirect code to '301 Moved Permanently'
    return navigateTo('/search', { redirectCode: 301 })
  }
})

当在路由中间件中使用 navigateTo 时，你必须 返回其结果，以确保中间件的执行流程正常工作。

例如，以下实现 将无法按预期工作

export default defineNuxtRouteMiddleware((to, from) => {
  if (to.path !== '/search') {
    // ❌ This will not work as expected
    navigateTo('/search', { redirectCode: 301 })
    return
  }
})

在这种情况下，navigateTo 会被执行但不会被返回，这可能导致意外的行为。

在 文档 > 4.x > 目录结构 > App > Middleware 中阅读更多内容。

导航到外部 URL

navigateTo 中的 external 参数会影响处理 URL 导航的方式

  • 如果不使用 external: true:
    • 内部 URL 按预期进行导航。
    • 外部 URL 会抛出错误。
  • 如果使用 external: true:
    • 内部 URL 会通过全页重新加载进行导航。
    • 外部 URL 按预期进行导航。

示例

<script setup lang="ts">
// will throw an error;
// navigating to an external URL is not allowed by default
await navigateTo('https://nuxtjs.org.cn')

// will redirect successfully with the 'external' parameter set to 'true'
await navigateTo('https://nuxtjs.org.cn', {
  external: true,
})
</script>

在新标签页中打开页面

<script setup lang="ts">
// will open 'https://nuxtjs.org.cn' in a new tab
await navigateTo('https://nuxtjs.org.cn', {
  open: {
    target: '_blank',
    windowFeatures: {
      width: 500,
      height: 500,
    },
  },
})
</script>

类型

签名
export function navigateTo (
  to: RouteLocationRaw | undefined | null,
  options?: NavigateToOptions,
): Promise<void | NavigationFailure | false> | false | void | RouteLocationRaw

interface NavigateToOptions {
  replace?: boolean
  redirectCode?: number
  external?: boolean
  open?: OpenOptions
}

type OpenOptions = {
  target: string
  windowFeatures?: OpenWindowFeatures
}

type OpenWindowFeatures = {
  popup?: boolean
  noopener?: boolean
  noreferrer?: boolean
} & XOR<{ width?: number }, { innerWidth?: number }>
  & XOR<{ height?: number }, { innerHeight?: number }>
  & XOR<{ left?: number }, { screenX?: number }>
  & XOR<{ top?: number }, { screenY?: number }>

参数

@BobbieGoede

类型: RouteLocationRaw| undefined | null

默认值: '/'

to 可以是一个纯字符串或路由对象，用于重定向。当作为 undefined 或 null 传递时，将默认为 '/'。

示例

// Passing the URL directly will redirect to the '/blog' page
await navigateTo('/blog')

// Using the route object, will redirect to the route with the name 'blog'
await navigateTo({ name: 'blog' })

// Redirects to the 'product' route while passing a parameter (id = 1) using the route object.
await navigateTo({ name: 'product', params: { id: 1 } })

options (可选)

类型: NavigateToOptions

一个接受以下属性的对象

  • replace
    • 类型：boolean
    • 默认值: false
    • 默认情况下，navigateTo 会在客户端将给定的路由推入 Vue Router 的实例中。
      可以通过设置 replace 为 true 来更改此行为，以表明应该替换给定的路由。
  • redirectCode
    • 类型：number
    • 默认值: 302
    • navigateTo 会重定向到给定的路径，并将重定向代码设置为302 Found这是当重定向发生在服务端时的默认值。
      可以通过提供不同的 redirectCode 来修改此默认行为。通常，301 Moved Permanently可用于永久重定向。
  • external
    • 类型：boolean
    • 默认值: false
    • 设置为 true 时，允许导航到外部 URL。否则，navigateTo 会抛出错误，因为默认情况下不允许外部导航。
  • open
    • 类型: OpenOptions
    • 允许使用open()窗口方法来导航到该 URL。此选项仅适用于客户端，在服务端将被忽略。
      一个接受以下属性的对象
    • target
      • 类型: string
      • 默认值: '_blank'
      • 一个不带空格的字符串，指定资源加载到的浏览上下文名称。
    • windowFeatures
      • 类型: OpenWindowFeatures
      • 一个接受以下属性的对象
        属性类型描述
        popupboolean请求一个最小化的弹出窗口而不是新标签页，UI 特性由浏览器决定。
        width 或 innerWidthnumber指定内容区域的宽度（至少 100 像素），包括滚动条。
        height 或 innerHeightnumber指定内容区域的高度（至少 100 像素），包括滚动条。
        left 或 screenXnumber设置新窗口相对于屏幕左边缘的水平位置。
        top 或 screenYnumber设置新窗口相对于屏幕顶边缘的垂直位置。
        noopenerboolean防止新窗口通过 window.opener 访问原始窗口。
        noreferrerboolean防止发送 Referer 请求头，并隐式启用 noopener。

        参考文档以获取有关 windowFeatures 属性的更详细信息。