aboutsummaryrefslogtreecommitdiffstats
path: root/src/ngRoute/routeParams.js
diff options
context:
space:
mode:
authorIgor Minar2013-06-05 15:30:31 -0700
committerIgor Minar2013-06-06 17:07:12 -0700
commit5599b55b04788c2e327d7551a4a699d75516dd21 (patch)
treedc080ce9639f44056eb6c476fb030923249ce265 /src/ngRoute/routeParams.js
parent7a5cfb593f27c28cee545974736632bf8da62fe8 (diff)
downloadangular.js-5599b55b04788c2e327d7551a4a699d75516dd21.tar.bz2
refactor($route): pull $route and friends into angular-route.js
$route, $routeParams and ngView have been pulled from core angular.js to angular-route.js/ngRoute module. This is was done to in order keep the core focused on most commonly used functionality and allow community routers to be freely used instead of $route service. There is no need to panic, angular-route will keep on being supported by the angular team. Note: I'm intentionally not fixing tutorial links. Tutorial will need bigger changes and those should be done when we update tutorial to 1.2. BREAKING CHANGE: applications that use $route will now need to load angular-route.js file and define dependency on ngRoute module. Before: ``` ... <script src="angular.js"></script> ... var myApp = angular.module('myApp', ['someOtherModule']); ... ``` After: ``` ... <script src="angular.js"></script> <script src="angular-route.js"></script> ... var myApp = angular.module('myApp', ['ngRoute', 'someOtherModule']); ... ``` Closes #2804
Diffstat (limited to 'src/ngRoute/routeParams.js')
-rw-r--r--src/ngRoute/routeParams.js33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/ngRoute/routeParams.js b/src/ngRoute/routeParams.js
new file mode 100644
index 00000000..0c86e89d
--- /dev/null
+++ b/src/ngRoute/routeParams.js
@@ -0,0 +1,33 @@
+'use strict';
+
+ngRouteModule.provider('$routeParams', $RouteParamsProvider);
+
+
+/**
+ * @ngdoc object
+ * @name ngRoute.$routeParams
+ * @requires $route
+ *
+ * @description
+ * Current set of route parameters. The route parameters are a combination of the
+ * {@link ng.$location $location} `search()`, and `path()`. The `path` parameters
+ * are extracted when the {@link ngRoute.$route $route} path is matched.
+ *
+ * In case of parameter name collision, `path` params take precedence over `search` params.
+ *
+ * The service guarantees that the identity of the `$routeParams` object will remain unchanged
+ * (but its properties will likely change) even when a route change occurs.
+ *
+ * @example
+ * <pre>
+ * // Given:
+ * // URL: http://server.com/index.html#/Chapter/1/Section/2?search=moby
+ * // Route: /Chapter/:chapterId/Section/:sectionId
+ * //
+ * // Then
+ * $routeParams ==> {chapterId:1, sectionId:2, search:'moby'}
+ * </pre>
+ */
+function $RouteParamsProvider() {
+ this.$get = function() { return {}; };
+}