Credit to devdocs.io

angularjs 1.4

angularjs

Improve this Doc View Source $route

  1. $routeProvider
  2. service in module ngRoute

$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.

Requires the ngRoute module to be installed.

You can define routes through $routeProvider's API.

The $route service is typically used in conjunction with the ngView directive and the $routeParams service.

Dependencies

Methods

  • reload();

    Causes $route service to reload the current route even if $location hasn't changed.

    As a result of that, ngView creates new scope and reinstantiates the controller.

  • updateParams(newParams);

    Causes $route service to update the current URL, replacing current route parameters with those specified in newParams. Provided property names that match the route's path segment definitions will be interpolated into the location's path, while remaining properties will be treated as query params.

    Parameters

    Param Type Details
    newParams !Object<string, string>

    mapping of URL parameter names to values

Events

  • $routeChangeStart

    Broadcasted before a route change. At this point the route services starts resolving all of the dependencies needed for the route change to occur. Typically this involves fetching the view template as well as any dependencies defined in resolve route property. Once all of the dependencies are resolved $routeChangeSuccess is fired.

    The route change (and the $location change that triggered it) can be prevented by calling preventDefault method of the event. See $rootScope.Scope for more details about event object.

    Type:

    broadcast

    Target:

    root scope

    Parameters

    Param Type Details
    angularEvent Object

    Synthetic event object.

    next Route

    Future route information.

    current Route

    Current route information.

  • $routeChangeSuccess

    Broadcasted after a route change has happened successfully. The resolve dependencies are now available in the current.locals property.

    ngView listens for the directive to instantiate the controller and render the view.

    Type:

    broadcast

    Target:

    root scope

    Parameters

    Param Type Details
    angularEvent Object

    Synthetic event object.

    current Route

    Current route information.

    previous RouteUndefined

    Previous route information, or undefined if current is first route entered.

  • $routeChangeError

    Broadcasted if any of the resolve promises are rejected.

    Type:

    broadcast

    Target:

    root scope

    Parameters

    Param Type Details
    angularEvent Object

    Synthetic event object

    current Route

    Current route information.

    previous Route

    Previous route information.

    rejection Route

    Rejection of the promise. Usually the error of the failed promise.

  • $routeUpdate

    The reloadOnSearch property has been set to false, and we are reusing the same instance of the Controller.

    Type:

    broadcast

    Target:

    root scope

    Parameters

    Param Type Details
    angularEvent Object

    Synthetic event object

    current Route

    Current/previous route information.

Properties

  • current

    Object

    Reference to the current route definition. The route definition contains:

    • controller: The controller constructor as define in route definition.
    • locals: A map of locals which is used by $controller service for controller instantiation. The locals contain the resolved values of the resolve map. Additionally the locals also contain:

      • $scope - The current route scope.
      • $template - The current route template HTML.
  • routes

    Object

    Object with all route configuration Objects as its properties.

This example shows how changing the URL hash causes the $route to match a route against the URL, and the ngView pulls in the partial.

© 2010–2017 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.4.14/docs/api/ngRoute/service/$route