vue-router 经常使用api详解

<router-link>

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

<router-link>Props

to

• 类型 string | Location
• required

表示目标路由的连接。当被点击后，内部会马上把 to 的值传到 router.push()，因此这个值能够是一个字符串或者是描述目标位置的对象。

<!--字符串-->
<router-link to="home">Home</router-link>
<!--渲染结果-->
<a href="home">Home</a>

<!--使用v-bind绑定-->
<router-link v-bind:to="home">Home</router-link>

<!--绑定对象的形式-->
<router-link v-bind:to="{path: 'home'}">Home</router-link>

<!--命名路由 下面的结果是：/user/123-->
<router-link :to="{name: 'user',params: {userId: 123}}"

<!--带查询参数，下面结果是：/user?plan=123-->
<router-link :to="{path: 'user', query: {plan: '123'}}">demo</router-link>
复制代码

replace

• 类型：boolean
• 默认值：false

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

<router-link :to="{ path: '/abc'}" replace></router-link>
复制代码

append

• 类型：string
• 默认值：false

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

<router-link :to="{ path: 'relative/path'}" append></router-link>
复制代码

tag

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

有时候想要 <router-link> 渲染成某种标签，例如 <li>。 因而咱们使用 tag prop 类指定何种标签，一样它仍是会监听点击，触发导航。

<router-link to="/foo" tag="li">foo</router-link>
<!-- 渲染结果 -->
<li>foo</li>
复制代码

active-class

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

设置 连接激活时使用的 CSS 类名。默认值能够经过路由的构造选项 linkActiveClass 来全局配置

<router-view>

<router-view> 组件是一个 functional 组件，渲染路径匹配到的视图组件。<router-view> 渲染的组件还能够内嵌本身的 <router-view>，根据嵌套路径，渲染嵌套组件。

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

由于它也是个组件，因此能够配合 <transition> 和 <keep-alive> 使用。若是两个结合一块儿用，要确保在内层使用 <keep-alive>

<transition>
  <keep-alive>
    <router-view></router-view>
  </keep-alive>
</transition>
复制代码

<router-view> Props

name

• 类型：string
• 默认值：default

若是<router-view>设置了名称，则会渲染对应的路由配置中的components下的相应组件。

Router 构建选项

routes

• 类型：Array<RouteConfig>

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<string>; //别名
  children?: Array<RouteConfig>; // 嵌套路由
  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<RouteRecord>

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

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