将 Props 传递给路由组件

观看 Vue School 上的免费视频课程

在组件中使用 $route 或 useRoute() 会与路由产生紧密耦合，这限制了组件的灵活性，因为它只能在某些 URL 上使用。虽然这并不一定是一件坏事，但我们可以通过 props 选项来解耦这种行为。

让我们回到我们之前的示例

<!-- User.vue -->
<template>
  <div>
    User {{ $route.params.id }}
  </div>
</template>

with

import User from './User.vue'

// these are passed to `createRouter`
const routes = [
  { path: '/users/:id', component: User },
]

我们可以通过声明一个 prop 来移除 User.vue 中对 $route 的直接依赖

组合式 API

<!-- User.vue -->
<script setup>
defineProps({
  id: String
})
</script>

<template>
  <div>
    User {{ id }}
  </div>
</template>

选项 API

<!-- User.vue -->
<script>
export default {
  props: {
    id: String
  }
}
</script>

<template>
  <div>
    User {{ id }}
  </div>
</template>

然后，我们可以通过设置 props: true 来配置路由，将 id 参数作为 prop 传递

const routes = [
  { path: '/user/:id', component: User, props: true }
]

这允许您在任何地方使用该组件，这使得组件更容易重用和测试。

布尔模式

当 props 设置为 true 时，route.params 将被设置为组件 props。

命名视图

对于具有命名视图的路由，您必须为每个命名视图定义 props 选项

const routes = [
  {
    path: '/user/:id',
    components: { default: User, sidebar: Sidebar },
    props: { default: true, sidebar: false }
  }
]

对象模式

当 props 是一个对象时，它将按原样设置为组件 props。当 props 是静态时很有用。

const routes = [
  {
    path: '/promotion/from-newsletter',
    component: Promotion,
    props: { newsletterPopup: false }
  }
]

函数模式

您可以创建一个返回 props 的函数。这允许您将参数转换为其他类型，将静态值与基于路由的值组合起来，等等。

const routes = [
  {
    path: '/search',
    component: SearchUser,
    props: route => ({ query: route.query.q })
  }
]

URL /search?q=vue 将把 {query: 'vue'} 作为 props 传递给 SearchUser 组件。

尝试保持 props 函数无状态，因为它只在路由更改时进行评估。如果您需要状态来定义 props，请使用包装组件，这样 Vue 就可以对状态更改做出反应。

通过 RouterView

您也可以通过 <RouterView> 插槽 传递任何 props

<RouterView v-slot="{ Component }">
  <component
    :is="Component"
    view-prop="value"
   />
</RouterView>

警告

在这种情况下，所有视图组件 都将收到 view-prop。这通常不是一个好主意，因为它意味着所有视图组件都声明了一个 view-prop prop，而这并不一定是真的。如果可能，请使用上述任何选项。