Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-05-09 15:24:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs($location): document $location's events

Browse source 
Closes #1569
Closes #4446
This commit is contained in:
Valentyn Shybanov 2013-10-16 01:48:35 +03:00 committed by Pete Bacon Darwin
parent 2cdb588b86
commit dfccdd5b86
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
src/ng/location.js
View file

@ -525,6 +525,35 @@ function $LocationProvider(){
return html5Mode; return html5Mode;
} }
}; };
/**
* @ngdoc event
* @name ng.$location#$locationChangeStart
* @eventOf ng.$location
* @eventType broadcast on root scope
* @description
* Broadcasted before a URL will change. This change can be prevented by calling
* `preventDefault` method of the event. See {@link ng.$rootScope.Scope#$on} for more
* details about event object. Upon successful change
* {@link ng.$location#$locationChangeSuccess $locationChangeSuccess} is fired.
*
* @param {Object} angularEvent Synthetic event object.
* @param {string} newUrl New URL
* @param {string=} oldUrl URL that was before it was changed.
*/
/**
* @ngdoc event
* @name ng.$location#$locationChangeSuccess
* @eventOf ng.$location
* @eventType broadcast on root scope
* @description
* Broadcasted after a URL was changed.
*
* @param {Object} angularEvent Synthetic event object.
* @param {string} newUrl New URL
* @param {string=} oldUrl URL that was before it was changed.
*/
this.$get = ['$rootScope', '$browser', '$sniffer', '$rootElement', this.$get = ['$rootScope', '$browser', '$sniffer', '$rootElement',
function( $rootScope, $browser, $sniffer, $rootElement) { function( $rootScope, $browser, $sniffer, $rootElement) {