參考原文:https://github.com/angular-ui/ui-router/wiki
ui-router 的工作原理非常類似于 Angular 的路由控制器,但它只關(guān)注狀態(tài).
- 在應(yīng)用程序的整個用戶界面和導(dǎo)航中耿眉,一個狀態(tài)對應(yīng)于一個頁面位置
- 通過定義controller慎璧、template和view等屬性域蜗,來定義指定位置的用戶界面和界面行為
- 通過嵌套的方式來解決頁面中的一些重復(fù)出現(xiàn)的部位
最簡單的形式
模板可以通過下面這種最簡單的方式來指定
<!-- in index.html -->
<body ng-controller="MainCtrl">
<section ui-view></section>
</body>
// in app-states.js (or whatever you want to name it)
$stateProvider.state('contacts', {
template: '<h1>My Contacts</h1>'
})
模板將被插入哪里?
狀態(tài)被激活時挺身,它的模板會自動插入到父狀態(tài)對應(yīng)的模板中包含ui-view
屬性的元素內(nèi)部。如果是頂層的狀態(tài)妥曲,那么它的父模板就是index.html
个粱。
激活狀態(tài)
有三種方法來激活狀態(tài):
- 調(diào)用
$state.go()
方法古毛,這是一個高級的便利方法; - 點擊包含
ui-sref
指令的鏈接都许; - 導(dǎo)航到與狀態(tài)相關(guān)聯(lián)的 url
Templates 模板
可以通過下面幾種方法來配置一個狀態(tài)的模板稻薇。
方法一:配置template
屬性,指定一段 HTML 字符串胶征,這人是設(shè)置模板的最簡單的方式
$stateProvider.state('contacts', {
template: '<h1>My Contacts</h1>'
})
方法二:配置templateUrl屬性塞椎,來加載指定位置的模板,這是設(shè)置模板的常用方法睛低。
$stateProvider.state('contacts', {
templateUrl: 'contacts.html'
})
templateUrl
的值也可以是一個函數(shù)返回的url
案狠,函數(shù)帶一個預(yù)設(shè)參數(shù)stateParams
服傍。
$stateProvider.state('contacts', {
templateUrl: function (stateParams){
return '/partials/contacts.' + stateParams.filterBy + '.html';
}
})
方法三:通過templateProvider函數(shù)返回模板的 HTML。
$stateProvider.state('contacts', {
templateProvider: function ($timeout, $stateParams) {
return $timeout(function () {
return '<h1>' + $stateParams.contactId + '</h1>'
}, 100);
}
})
如果想在狀態(tài)被激活前骂铁,讓<ui-view>
有一些默認(rèn)的內(nèi)容吹零,當(dāng)狀態(tài)被激活之后默認(rèn)內(nèi)容將被狀態(tài)對應(yīng)的模板替換。
<body>
<ui-view>
<i>Some content will load here!</i>
</ui-view>
</body>
Controllers 控制器
可以為模板指定一個控制器(controller)拉庵。警告:控制器不會被實例化如果模板沒有定義灿椅。
設(shè)置控制器:
$stateProvider.state('contacts', {
template: '<h1>{{title}}</h1>',
controller: function($scope){
$scope.title = 'My Contacts';
}
})
如果在模塊中已經(jīng)定義了一個控制器,只需要指定控制器的名稱即可:
$stateProvider.state('contacts', {
template: ...,
controller: 'ContactsCtrl'
})
使用controllerAs
語法:
$stateProvider.state('contacts', {
template: ...,
controller: 'ContactsCtrl as contact'
})
對于更高級的需要钞支,可以使用controllerProvider
來動態(tài)返回一個控制器函數(shù)或字符串:
$stateProvider.state('contacts', {
template: ...,
controllerProvider: function($stateParams) {
var ctrlName = $stateParams.type + "Controller";
return ctrlName;
}
})
控制器可以使用$scope.on()
方法來監(jiān)聽事件狀態(tài)轉(zhuǎn)換茫蛹。
控制器可以根據(jù)需要實例化,當(dāng)相應(yīng)的scope
被創(chuàng)建時烁挟。例如婴洼,當(dāng)用戶點擊一個url手動導(dǎo)航一個狀態(tài)時,$stateProvider
將加載對應(yīng)的模板到視圖中信夫,并且將控制器和模板的scope
綁定在一起窃蹋。
解決器 Resolve
可以使用resolve為控制器提供可選的依賴注入項。
- resolve配置項是一個由key/value構(gòu)成的對象静稻。
- key – {string}:注入控制器的依賴項名稱。
- factory - {string|function}:
- string:一個服務(wù)的別名
- function:函數(shù)的返回值將作為依賴注入項匈辱,如果函數(shù)是一個耗時的操作振湾,那么控制器必須等待該函數(shù)執(zhí)行完成(be resolved)才會被實例化。
例子
在controller實例化之前亡脸,resolve中的每一個對象都必須 be resolved押搪,請注意每個 resolved object 是怎樣作為參數(shù)注入到控制器中的。
$stateProvider.state('myState', {
resolve:{
// Example using function with simple return value.
// Since it's not a promise, it resolves immediately.
simpleObj: function(){
return {value: 'simple!'};
},
// Example using function with returned promise.
// 這是一種典型使用方式
// 請給函數(shù)注入任何想要的服務(wù)依賴浅碾,例如 $http
promiseObj: function($http){
// $http returns a promise for the url data
return $http({method: 'GET', url: '/someUrl'});
},
// Another promise example.
// 如果想對返回結(jié)果進(jìn)行處理大州, 可以使用 .then 方法
// 這是另一種典型使用方式
promiseObj2: function($http){
return $http({method: 'GET', url: '/someUrl'})
.then (function (data) {
return doSomeStuffFirst(data);
});
},
// 使用服務(wù)名的例子,這將在模塊中查找名稱為 'translations' 的服務(wù)垂谢,并返回該服務(wù)
// Note: The service could return a promise and
// it would work just like the example above
translations: "translations",
// 將服務(wù)模塊作為解決函數(shù)的依賴項厦画,通過參數(shù)傳入
// 提示:依賴項 $stateParams 代表 url 中的參數(shù)
translations2: function(translations, $stateParams){
// Assume that getLang is a service method
// that uses $http to fetch some translations.
// Also assume our url was "/:lang/home".
translations.getLang($stateParams.lang);
},
// Example showing returning of custom made promise
greeting: function($q, $timeout){
var deferred = $q.defer();
$timeout(function() {
deferred.resolve('Hello!');
}, 1000);
return deferred.promise;
}
},
// 控制器將等待上面的解決項都被解決后才被實例化
controller: function($scope, simpleObj, promiseObj, promiseObj2, translations, translations2, greeting){
$scope.simple = simpleObj.value;
// 這里可以放心使用 promiseObj 中的對象
$scope.items = promiseObj.items;
$scope.items = promiseObj2.items;
$scope.title = translations.getLang("english").title;
$scope.title = translations2.title;
$scope.greeting = greeting;
}
})
為 $state 對象提供自定義數(shù)據(jù)
可以給$state
對象提供自定義數(shù)據(jù)(建議使用data屬性,以免沖突)
// 基于對象和基于字符串定義 state 的例子
var contacts = {
name: 'contacts',
templateUrl: 'contacts.html',
data: {
customData1: 5,
customData2: "blue"
}
}
$stateProvider
.state(contacts)
.state('contacts.list', {
templateUrl: 'contacts.list.html',
data: {
customData1: 44,
customData2: "red"
}
})
可以通過下面的方式來訪問上面定義的數(shù)據(jù):
function Ctrl($state){
console.log($state.current.data.customData1) // 輸出 5;
console.log($state.current.data.customData2) // 輸出 "blue";
}
onEnter 和 onExit 回調(diào)函數(shù)
onEnter
和onExit
回調(diào)函數(shù)是可選配置項滥朱,分別稱為當(dāng)一個狀態(tài)變得活躍的和不活躍的時候觸發(fā)根暑。回調(diào)函數(shù)也可以訪問所有解決依賴項徙邻。
$stateProvider.state("contacts", {
template: '<h1>{{title}}</h1>',
resolve: { title: 'My Contacts' },
controller: function($scope, title){
$scope.title = 'My Contacts';
},
// title 是解決依賴項排嫌,這里也是可以使用解決依賴項的
onEnter: function(title){
if(title){ ... do something ... }
},
// title 是解決依賴項,這里也是可以使用解決依賴項的
onExit: function(title){
if(title){ ... do something ... }
}
})
State Change Events 狀態(tài)改變事件
所有這些事件都是在$rootScope
作用域觸發(fā)
-
$stateChangeStart
- 當(dāng)模板開始解析之前觸發(fā)
$rootScope.$on('$stateChangeStart',
function(event, toState, toParams, fromState, fromParams){ ... })
注意:使用event.preventDefault()可以阻止模板解析的發(fā)生
$rootScope.$on('$stateChangeStart',
function(event, toState, toParams, fromState, fromParams){
event.preventDefault();
// transitionTo() promise will be rejected with
// a 'transition prevented' error
})
-$stateNotFound
- v0.3.0 - 在 transition
時通過狀態(tài)名查找狀態(tài)缰犁,當(dāng)狀態(tài)無法找到時發(fā)生淳地。該事件在 scope
鏈上廣播怖糊,只允許一次處理錯誤的機(jī)會。unfoundState
將作為參數(shù)傳入事件監(jiān)聽函數(shù)颇象,下面例子中可以看到unfoundState
的三個屬性蓬抄。使用 event.preventDefault()
來阻止模板解析
// somewhere, assume lazy.state has not been defined
$state.go("lazy.state", {a:1, b:2}, {inherit:false});
// somewhere else
$scope.$on('$stateNotFound',
function(event, unfoundState, fromState, fromParams){
console.log(unfoundState.to); // "lazy.state"
console.log(unfoundState.toParams); // {a:1, b:2}
console.log(unfoundState.options); // {inherit:false} + default options
})
-
$stateChangeSuccess
- 當(dāng)模板解析完成后觸發(fā)
$rootScope.$on('$stateChangeSuccess',
function(event, toState, toParams, fromState, fromParams){ ... })
-
$stateChangeError
- 當(dāng)模板解析過程中發(fā)生錯誤時觸發(fā)
$rootScope.$on('$stateChangeError',
function(event, toState, toParams, fromState, fromParams, error){ ... })
View Load Events 視圖加載事件
$viewContentLoading
- 當(dāng)視圖開始加載,DOM渲染完成之前觸發(fā)夯到,該事件將在$scope鏈上廣播此事件嚷缭。
$scope.$on('$viewContentLoading',
function(event, viewConfig){
// Access to all the view config properties.
// and one special property 'targetView'
// viewConfig.targetView
});
-
$viewContentLoaded
- 當(dāng)視圖加載完成,DOM渲染完成之后觸發(fā)耍贾,視圖所在的$scope發(fā)出該事件阅爽。
$scope.$on('$viewContentLoading',
$scope.$on('$viewContentLoaded',
function(event){ ... });
轉(zhuǎn)載自http://bubkoo.com/2014/01/01/angular/ui-router/guide/state-manager/