Vue-router的API詳解

前面的話

　　本文將詳細介紹Vue-router的API

 

router-link

　　<router-link> 組件支持用戶在具備路由功能的應用中點擊導航。 經過 to 屬性指定目標地址，默認渲染成帶有正確連接的 <a> 標籤，能夠經過配置 tag 屬性生成別的標籤。另外，當目標路由成功激活時，連接元素自動設置一個表示激活的 CSS 類名

　　<router-link> 比起寫死的 <a href="..."> 會好一些。不管是 HTML5 history 模式仍是 hash 模式，它的表現行爲一致，因此，當切換路由模式，或者在 IE9 降級使用 hash 模式，無須做任何變更；在 HTML5 history 模式下，router-link 會攔截點擊事件，讓瀏覽器再也不從新加載頁面；在 HTML5 history 模式下使用 base 選項以後，全部的 to 屬性都不須要寫基路徑了

【props】

to(required)

類型 string | Location

　　表示目標路由的連接。當被點擊後，內部會馬上把 to 的值傳到 router.push()，因此這個值能夠是一個字符串或者是描述目標位置的對象

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

  <!-- 使用 v-bind 的 JS 表達式 -->
  <router-link v-bind:to="'home'">Home</router-link>

  <!-- 不寫 v-bind 也能夠，就像綁定別的屬性同樣 -->
  <router-link :to="'home'">Home</router-link>

  <!-- 同上 -->
  <router-link :to="{ path: 'home' }">Home</router-link>

  <!-- 命名的路由 -->
  <router-link :to="{ name: 'user', params: { userId: 123 }}">User</router-link>

  <!-- 帶查詢參數，下面的結果爲 /register?plan=private -->
  <router-link :to="{ path: 'register', query: { plan: 'private' }}">Register</router-link>

replace

類型: boolean
默認值: false

　　設置 replace 屬性的話，當點擊時，會調用 router.replace() 而不是 router.push()，因而導航後不會留下 history 記錄

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

append

類型: boolean
默認值: 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 來全局配置

exact

類型: boolean
默認值: false

　　是否激活默認類名的依據是 inclusive match （全包含匹配）。 舉個例子，若是當前的路徑是 /a 開頭的，那麼 <router-link to="/a"> 也會被設置 CSS 類名

　　按照這個規則，<router-link to="/"> 將會點亮各個路由。想要連接使用 "exact 匹配模式"，則使用 exact 屬性

  <!-- 這個連接只會在地址爲 / 的時候被激活 -->
  <router-link to="/" exact>

events

類型: string | Array<string>
默認值: 'click'

　　聲明能夠用來觸發導航的事件。能夠是一個字符串或是一個包含字符串的數組

【將"激活時的CSS類名"應用在外層元素】

　　有時候要讓 "激活時的CSS類名" 應用在外層元素，而不是 <a> 標籤自己，那麼能夠用 <router-link> 渲染外層元素，包裹着內層的原生 <a> 標籤：

<router-link tag="li" to="/foo">
  <a>/foo</a>
</router-link>

　　在這種狀況下，<a> 將做爲真實的連接（它會得到正確的 href 的），而 "激活時的CSS類名" 則設置到外層的 <li>

 

router-view

　　<router-view> 組件是一個 functional 組件，渲染路徑匹配到的視圖組件。<router-view> 渲染的組件還能夠內嵌本身的 <router-view>，根據嵌套路徑，渲染嵌套組件

【屬性】

name

類型: string
默認值: "default"

　　若是 <router-view>設置了名稱，則會渲染對應的路由配置中 components 下的相應組件

【行爲表現】

　　其餘屬性（非 router-view 使用的屬性）都直接傳給渲染的組件， 不少時候，每一個路由的數據都是包含在路由參數中。

　　由於它也是個組件，因此能夠配合 <transition> 和 <keep-alive> 使用。若是兩個結合一塊兒用，要確保在內層使用 <keep-alive>：

<transition>
  <keep-alive>
    <router-view></router-view>
  </keep-alive>
</transition>

 

路由信息對象

　　一個 route object（路由信息對象） 表示當前激活的路由的狀態信息，包含了當前 URL 解析獲得的信息，還有 URL 匹配到的 route records（路由記錄）

　　route object 是 immutable（不可變） 的，每次成功的導航後都會產生一個新的對象。route object 出如今多個地方，包括以下

　　一、組件內的 this.$route 和 $route watcher 回調（監測變化處理）

　　二、router.match(location) 的返回值

　　三、導航鉤子的參數

router.beforeEach((to, from, next) => {
  // to 和 from 都是 路由信息對象
})

　　四、scrollBehavior 方法的參數

const router = new VueRouter({
  scrollBehavior (to, from, savedPosition) {
    // to 和 from 都是 路由信息對象
  }
})

【屬性】

$route.path

類型: string

　　字符串，對應當前路由的路徑，老是解析爲絕對路徑，如 "/foo/bar"

$route.params

類型: Object

　　一個 key/value 對象，包含了 動態片斷 和 全匹配片斷，若是沒有路由參數，就是一個空對象

$route.query

類型: Object

　　一個 key/value 對象，表示 URL 查詢參數。例如，對於路徑 /foo?user=1，則有 $route.query.user = 1，若是沒有查詢參數，則是個空對象

$rout.hash

類型: string

　　當前路由的 hash 值 (帶 #) ，若是沒有 hash 值，則爲空字符串

$route.fullPath

類型: string

　　完成解析後的 URL，包含查詢參數和 hash 的完整路徑

$route.matched

類型: Array<RouteRecord>

　　一個數組，包含當前路由的全部嵌套路徑片斷的 路由記錄 。路由記錄就是 routes 配置數組中的對象副本（還有在 children 數組）

const router = new VueRouter({
  routes: [
    // 下面的對象就是 route record
    { path: '/foo', component: Foo,
      children: [
        // 這也是個 route record
        { path: 'bar', component: Bar }
      ]
    }
  ]
})

　　當 URL 爲 /foo/bar，$route.matched 將會是一個包含從上到下的全部對象（副本）

$route.name

　　當前路由的名稱，若是有的話

 

Router構造配置

【routes】

類型: Array<RouteConfig>

　　RouteConfig 的類型定義：

declare type RouteConfig = {
  path: string;
  component?: Component;
  name?: string; // for named routes (命名路由)
  components?: { [name: string]: Component }; // for named views (命名視圖組件)
  redirect?: string | Location | Function;
  alias?: string | Array<string>;
  children?: Array<RouteConfig>; // for nested routes (嵌套路由)
  beforeEnter?: (to: Route, from: Route, next: Function) => void;
  meta?: any;
}

【mode】

類型: string
默認值: "hash" (瀏覽器環境) | "abstract" (Node.js 環境)
可選值: "hash" | "history" | "abstract"

　　配置路由模式

　　一、hash: 使用 URL hash 值來做路由。支持全部瀏覽器，包括不支持 HTML5 History Api 的瀏覽器

　　二、history: 依賴 HTML5 History API 和服務器配置

　　三、abstract: 支持全部 JavaScript 運行環境，如 Node.js 服務器端。若是發現沒有瀏覽器的 API，路由會自動強制進入這個模式

【base】

類型: string
默認值: "/"

　　應用的基路徑。例如，若是整個單頁應用服務在 /app/ 下，而後 base 就應該設爲 "/app/"

【linkActiveClass】

類型: string
默認值: "router-link-active"

　　全局配置 <router-link> 的默認『激活 class 類名』

【scrollBehavior】

類型: Function

　　簽名：

(
  to: Route,
  from: Route,
  savedPosition?: { x: number, y: number }
) => { x: number, y: number } | { selector: string } | ?{}

 

Router實例

【屬性】

router.app

類型: Vue instance

　　配置了 router 的 Vue 根實例

router.mode

類型: string

　　路由使用的 模式

router.currentRoute

類型: Route

　　當前路由對應的路由信息對象

【方法】

router.beforeEach(guard)
router.beforeResolve(guard) (2.5.0+): 此時異步組件已經加載完成
router.afterEach(hook):增長全局的導航鉤子
router.push(location, onComplete?, onAbort?)
router.replace(location, onComplete?, onAbort?)
router.go(n)
router.back()
router.forward():動態的導航到一個新 url

router.getMatchedComponents(location?)
返回目標位置或是當前路由匹配的組件數組（是數組的定義/構造類，不是實例）。一般在服務端渲染的數據預加載時

router.resolve(location, current?, append?)
解析目標位置（格式和 <router-link> 的 to prop 同樣），返回包含以下屬性的對象
{
　　location:Location;
　　route:Route;
　　href:string;
}

router.addRoutes(routes) 
動態添加更多的路由規則。參數必須是一個符合 routes 選項要求的數組

router.onReady(callback)
添加一個會在第一次路由跳轉完成時被調用的回調函數。此方法一般用於等待異步的導航鉤子完成，好比在進行服務端渲染的時候

 

對組件注入

【注入的屬性】

　　經過在 Vue 根實例的 router 配置傳入 router 實例，下面這些屬性成員會被注入到每一個子組件

$router

　　router 實例

$route

　　當前激活的路由信息對象。這個屬性是隻讀的，裏面的屬性是 immutable（不可變） 的，不過能夠 watch（監測變化） 它

【容許的額外配置】

beforeRouteEnter
beforeRouteLeave