Interface IRoute

see http://docs.angularjs.org/api/ngRoute/provider/$routeProvider#when for API documentation

Hierarchy

Index

Properties

Properties

optional public caseInsensitiveMatch?: boolean

Match routes without being case sensitive

This option defaults to false. If the option is set to true, then the particular route can be matched without being case sensitive

optional public controller?: any

{(string|function()=} Controller fn that should be associated with newly created scope or the name of a registered controller if passed as a string.

optional public controllerAs?: string

A controller alias name. If present the controller will be published to scope under the controllerAs name.

optional public name?: string

Undocumented?

optional public redirectTo?: any

{(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.} - 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.path() and $location.search().

optional public reloadOnSearch?: boolean

Reload route when only $location.search() or $location.hash() changes.

This option defaults to true. If the option is set to false and url in the browser changes, then $routeUpdate event is broadcasted on the root scope.

optional public resolve?: any

{Object.=} - 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. 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.

optional public template?: string

{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.} - route parameters extracted from the current $location.path() by applying the current route

optional public templateUrl?: any

{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.} - route parameters extracted from the current $location.path() by applying the current route