-
controller
– {(string|Function)=}
– Controller fn that should be associated with newly created scope or the name of a registered controller if passed as a string. -
controllerAs
– {string=}
– An identifier name for a reference to the controller. If present, the controller will be published to scope under the controllerAs
name. -
template
– {(string|Function)=}
– html template as a string or a function that returns an html template as a string which should be used by ngView or ngInclude directives. This property takes precedence over templateUrl
.
If template
is a function, it will be called with the following parameters:
-
{Array.<Object>}
- route parameters extracted from the current $location.path()
by applying the current route
One of template
or templateUrl
is required.
-
templateUrl
– {(string|Function)=}
– path or function that returns a path to an html template that should be used by ngView.
If templateUrl
is a function, it will be called with the following parameters:
-
{Array.<Object>}
- route parameters extracted from the current $location.path()
by applying the current route
One of templateUrl
or template
is required.
-
resolve
- {Object.<string, Function>=}
- An optional map of dependencies which should be injected into the controller. If any of these dependencies are promises, the router will wait for them all to be resolved or one to be rejected before the controller is instantiated. If all the promises are resolved successfully, the values of the resolved promises are injected and $routeChangeSuccess event is fired. If any of the promises are rejected the $routeChangeError event is fired. For easier access to the resolved dependencies from the template, the resolve
map will be available on the scope of the route, under $resolve
(by default) or a custom name specified by the resolveAs
property (see below). This can be particularly useful, when working with components as route templates.
Note: If your scope already contains a property with this name, it will be hidden or overwritten. Make sure, you specify an appropriate name for this property, that does not collide with other properties on the scope.
The map object is: -
key
– {string}
: a name of a dependency to be injected into the controller. -
factory
- {string|Function}
: If string
then it is an alias for a service. Otherwise if function, then it is injected and the return value is treated as the dependency. If the result is a promise, it is resolved before its value is injected into the controller. Be aware that ngRoute.$routeParams
will still refer to the previous route within these resolve functions. Use $route.current.params
to access the new route parameters, instead.
-
resolveAs
- {string=}
- The name under which the resolve
map will be available on the scope of the route. If omitted, defaults to $resolve
.
-
redirectTo
– {(string|Function)=}
– value to update $location path with and trigger route redirection.
If redirectTo
is a function, it will be called with the following parameters:
-
{Object.<string>}
- route parameters extracted from the current $location.path()
by applying the current route templateUrl. -
{string}
- current $location.path()
-
{Object}
- current $location.search()
The custom redirectTo
function is expected to return a string which will be used to update $location.url()
. If the function throws an error, no further processing will take place and the $routeChangeError event will be fired.
Routes that specify redirectTo
will not have their controllers, template functions or resolves called, the $location
will be changed to the redirect url and route processing will stop. The exception to this is if the redirectTo
is a function that returns undefined
. In this case the route transition occurs as though there was no redirection.
-
resolveRedirectTo
– {Function=}
– a function that will (eventually) return the value to update $location URL with and trigger route redirection. In contrast to redirectTo
, dependencies can be injected into resolveRedirectTo
and the return value can be either a string or a promise that will be resolved to a string.
Similar to redirectTo
, if the return value is undefined
(or a promise that gets resolved to undefined
), no redirection takes place and the route transition occurs as though there was no redirection.
If the function throws an error or the returned promise gets rejected, no further processing will take place and the $routeChangeError event will be fired.
redirectTo
takes precedence over resolveRedirectTo
, so specifying both on the same route definition, will cause the latter to be ignored.
-
[reloadOnUrl=true]
- {boolean=}
- reload route when any part of the URL changes (including the path) even if the new URL maps to the same route.
If the option is set to false
and the URL in the browser changes, but the new URL maps to the same route, then a $routeUpdate
event is broadcasted on the root scope (without reloading the route).
-
[reloadOnSearch=true]
- {boolean=}
- reload route when only $location.search()
or $location.hash()
changes.
If the option is set to false
and the URL in the browser changes, then a $routeUpdate
event is broadcasted on the root scope (without reloading the route).
Note: This option has no effect if reloadOnUrl
is set to false
.
-
[caseInsensitiveMatch=false]
- {boolean=}
- match routes without being case sensitive
If the option is set to true
, then the particular route can be matched without being case sensitive