vue-router 常用api详解

组件支持用户在具有路由功能的应用中 (点击) 导航。 通过 to 属性指定目标地址，默认渲染成带有正确链接的 标签，可以通过配置 tag 属性生成别的标签。另外，当目标路由成功激活时，链接元素自动设置一个表示激活的 CSS 类名

Props

to

• 类型 string | Location
• required

表示目标路由的链接。当被点击后，内部会立刻把 to 的值传到 router.push()，所以这个值可以是一个字符串或者是描述目标位置的对象。

"home">Home

"home">Home


"home">Home


"{path: 'home'}">Home


"{name: 'user',params: {userId: 123}}"


"{path: 'user', query: {plan: '123'}}">demo
复制代码

replace

• 类型：boolean
• 默认值：false

设置 replace 属性的话，当点击时，会调用 router.replace() 而不是 router.push()，于是导航后不会留下 history 记录。

"{ path: '/abc'}" replace>
复制代码

append

• 类型：string
• 默认值：false

设置 append 属性后，则在当前 (相对) 路径前添加基路径。例如，我们从 /a 导航到一个相对路径 b，如果没有配置 append，则路径为 /b，如果配了，则为 /a/b

"{ path: 'relative/path'}" append>
复制代码

tag

• 类型：string
• 默认值："a"

有时候想要 渲染成某种标签，例如

。 于是我们使用 tag prop 类指定何种标签，同样它还是会监听点击，触发导航。

"/foo" tag="li">foo

foo
复制代码

active-class

• 类型：string
• 默认值：router-link-active

设置 链接激活时使用的 CSS 类名。默认值可以通过路由的构造选项 linkActiveClass 来全局配置

组件是一个 functional 组件，渲染路径匹配到的视图组件。 渲染的组件还可以内嵌自己的 ，根据嵌套路径，渲染嵌套组件。

其他属性 (非 router-view 使用的属性) 都直接传给渲染的组件， 很多时候，每个路由的数据都是包含在路由参数中。

因为它也是个组件，所以可以配合 和 使用。如果两个结合一起用，要确保在内层使用

  
    
  

复制代码

Props

name

• 类型：string
• 默认值：default

如果设置了名称，则会渲染对应的路由配置中的components下的相应组件。

Router 构建选项

routes

• 类型：Array

RouteConfig的类型定义：

declare type RouteConfig = {
  path: string; //路径
  component?: Component;
  name?: string; // 命名路由
  components?: { [name: string]: Component }; // 命名视图组件
  redirect?: string | Location | Function; //重定向
  props?: boolean | Object | Function;
  alias?: string | Array; //别名
  children?: Array; // 嵌套路由
  beforeEnter?: (to: Route, from: Route, next: Function) => void;
  meta?: any; //路由元信息 使用$route.meta.属性可以获取

  // 2.6.0+
  caseSensitive?: boolean; // 匹配规则是否大小写敏感？(默认值：false)
  pathToRegexpOptions?: Object; // 编译正则的选项
}
复制代码

mode

• 类型：string
• 默认值：hash浏览器环境 | abstractnode.js环境
• 可选值："hash" | "history" | "abstract"

配置路由模式：

• hash:使用 URL hash 值来作路由。支持所有浏览器，包括不支持 HTML5 History Api 的浏览器。
• history:依赖 HTML5 History API 和服务器配置。查看 HTML5 History 模式。
• abstract:支持所有 JavaScript 运行环境，如 Node.js 服务器端。如果发现没有浏览器的 API，路由会自动强制进入这个模式

路由对象属性

$router.path

• 类型:string

字符串，对应当前路由的路径，总是解析为绝对路径，如 "/foo/bar"

$router.params

• 类型：Object

一个 key/value 对象，包含了动态片段和全匹配片段，如果没有路由参数，就是一个空对象。

$router.query

• 类型：Object

一个 key/value 对象，表示 URL 查询参数。例如，对于路径 /foo?user=1，则有 $route.query.user == 1，如果没有查询参数，则是个空对象。

$route.hash

• 类型：string

当前路由的 hash 值 (带 #) ，如果没有 hash 值，则为空字符串。

$route.fullPath

• 类型：string

完成解析后的 URL，包含查询参数和 hash 的完整路径。

$route.matched

• 类型：Array

一个数组，包含当前路由的所有嵌套路径片段的路由记录 。路由记录就是 routes 配置数组中的对象副本 (还有在 children 数组)。

const router = new VueRouter({
  routes: [
    // 下面的对象就是路由记录
    { path: '/foo', component: Foo,
      children: [
        // 这也是个路由记录
        { path: 'bar', component: Bar }
      ]
    }
  ]
})
复制代码