API 文档 / RouterOptions

接口: RouterOptions

用于初始化 Router 实例的选项。

继承关系

• PathParserOptions

  ↳ RouterOptions

属性

end

• 可选 end: boolean

是否应该通过在 RegExp 后面追加一个 $ 来匹配到结尾。

默认值

true

继承自

PathParserOptions.end

---

history

• history: RouterHistory

路由器使用的历史实现。大多数 Web 应用程序应该使用 createWebHistory，但这需要服务器正确配置。你也可以使用基于 hash 的历史记录 createWebHashHistory，它不需要在服务器上进行任何配置，但不会被搜索引擎处理，并且在 SEO 方面表现不佳。

示例

createRouter({
  history: createWebHistory(),
  // other options...
})

---

linkActiveClass

• 可选 linkActiveClass: string

应用于活动 RouterLink 的默认类。如果没有提供，将应用 router-link-active。

---

linkExactActiveClass

• 可选 linkExactActiveClass: string

应用于精确活动 RouterLink 的默认类。如果没有提供，将应用 router-link-exact-active。

---

parseQuery

• 可选 parseQuery: (search: string) => LocationQuery

解析查询的自定义实现。请参阅其对应项，RouterOptions.stringifyQuery。

示例

假设你想要使用 qs 包 来解析查询，你可以同时提供 parseQuery 和 stringifyQuery

import qs from 'qs'

createRouter({
  // other options...
  parseQuery: qs.parse,
  stringifyQuery: qs.stringify,
})

类型声明

▸ (search): LocationQuery

解析查询的自定义实现。请参阅其对应项，RouterOptions.stringifyQuery。

参数

名称	类型
search	string

返回值

LocationQuery

示例

假设你想要使用 qs 包 来解析查询，你可以同时提供 parseQuery 和 stringifyQuery

import qs from 'qs'

createRouter({
  // other options...
  parseQuery: qs.parse,
  stringifyQuery: qs.stringify,
})

---

routes

• routes: readonly RouteRecordRaw[]

应该添加到路由器的初始路由列表。

---

scrollBehavior

• 可选 scrollBehavior: RouterScrollBehavior

在页面之间导航时控制滚动的函数。可以返回一个 Promise 来延迟滚动。查看 ScrollBehavior。

示例

function scrollBehavior(to, from, savedPosition) {
  // `to` and `from` are both route locations
  // `savedPosition` can be null if there isn't one
}

---

sensitive

• 可选 sensitive: boolean

使 RegExp 区分大小写。

默认值

false

继承自

PathParserOptions.sensitive

---

strict

• 可选 strict: boolean

是否允许尾部斜杠。

默认值

false

继承自

PathParserOptions.strict

---

stringifyQuery

• 可选 stringifyQuery: (query: LocationQueryRaw) => string

用于将查询对象字符串化的自定义实现。不应在前面添加前导 ?。 parseQuery 的对应项用于处理查询解析。

类型声明

▸ (query): string

用于将查询对象字符串化的自定义实现。不应在前面添加前导 ?。 parseQuery 的对应项用于处理查询解析。

参数

名称	类型
query	LocationQueryRaw

返回值

string