RouterOptions Interface

初始化 Router 实例的选项。

Hierarchy

Properties

end

• Optional end: boolean

RegExp 是否应该通过向其附加一个$来匹配到最后。

Default Value

true

Inherited from

PathParserOptions.end

history

• history: RouterHistory

路由器使用的历史实现。 大多数网络应用程序应该使用createWebHistory，但它需要正确配置服务器。 您还可以将基于 hash 的历史记录与 createWebHashHistory 一起使用，它不需要在服务器上进行任何配置，但搜索引擎根本不处理，并且在 SEO 上表现不佳。

Example

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

linkActiveClass

• Optional linkActiveClass: string

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

linkExactActiveClass

• Optional linkExactActiveClass: string

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

parseQuery

• Optional parseQuery:

用于解析查询的自定义实现。 请参阅其对应项 stringifyQuery。

Example

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

js
import qs from 'qs'

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

routes

• routes: 只读 RouteRecordRaw

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

scrollBehavior

• Optional scrollBehavior: RouterScrollBehavior

在页面之间导航时控制滚动的功能。 可以返回一个 Promise 来延迟滚动。 检查滚动行为。

Example

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

sensitive

• Optional sensitive: boolean

使 RegExp 区分大小写。

Default Value

false

Inherited from

PathParserOptions.sensitive

strict

• Optional strict: boolean

是否禁止尾部斜杠。

Default Value

false

Inherited from

PathParserOptions.strict

stringifyQuery

• Optional stringifyQuery:

对查询对象进行字符串化的自定义实现。 不应在前面加上前导 ?。 parseQuery 对应处理查询解析。