Improve this Doc



First include angular-route.js in your HTML:

<script src="angular.js">
<script src="angular-route.js">

You can download this file from the following places:

where X.Y.Z is the AngularJS version you are running.

Then load the module in your application by adding it as a dependent module:

angular.module('app', ['ngRoute']);

With that you're ready to get started!


The ngRoute module provides routing and deeplinking services and directives for angular apps.


See $route for an example of configuring and using ngRoute.

Known Issues


If ngView is contained in an asynchronously loaded template (e.g. in another directive's templateUrl or in a template loaded using ngInclude), then you need to make sure that $route is instantiated in time to capture the initial $locationChangeStart event and load the appropriate view. One way to achieve this is to have it as a dependency in a .run block:['$route', function() {}]);

Module Components


Name Description


ngView is a directive that complements the $route service by including the rendered template of the current route into the main layout (index.html) file. Every time the current route changes, the included view changes with it according to the configuration of the $route service.


Name Description

Used for configuring routes.


Name Description

$route is used for deep-linking URLs to controllers and views (HTML partials). It watches $location.url() and tries to map the path to an existing route definition.


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