View source Improve this doc

$routeParams

service in module ngRoute

Description

The $routeParams service allows you to retrieve the current set of route parameters.

Requires the ngRoute module to be installed.

The route parameters are a combination of $location's search() and path(). The path parameters are extracted when the $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.

Note that the $routeParams are only updated after a route change completes successfully. This means that you cannot rely on $routeParams being correct in route resolve functions. Instead you can use $route.current.params to access the new route's parameters.

Dependencies

  • $route

Example

  1. // Given:
  2. // URL: http://server.com/index.html#/Chapter/1/Section/2?search=moby
  3. // Route: /Chapter/:chapterId/Section/:sectionId
  4. //
  5. // Then
  6. $routeParams ==> {chapterId:1, sectionId:2, search:'moby'}