Understanding Aurelia Router Events

Last updated: January 10, 2018

Unknown to some is the Aurelia router supports events. Using the Event Aggregator dependency in Aurelia, we can actually listen to various events fired via the router. All events can be subscribed to using the Event Aggregator dependency and the subscribe method.

It is worth noting that you don’t always need to use the Event Aggregator, sometimes a router pipeline step is all that is needed to hook into a certain aspect of the router flow and in some cases, this might be the desired choice.

The events the Aurelia router fires are as follows:

  • router:navigation:processing
  • router:navigation:error
  • router:navigation:canceled
  • router:navigation:success
  • router:navigation:complete

Rather than digging through the documentation yourself, here you go. But you’re probably wondering, at what stage do any or all of these get called within the lifecycle of the router? Good question.

router:navigation:processing

This event appears to be fired for anything that relates to the router doing something. Looking in the unit test which has some insights, we can see that when the router successfully navigates, is cancelled or errors out, that this event is always fired. Basically this event is saying, “every time you see this fired, the router is processing a route instruction”

router:navigation:error

A pretty obvious event. When there is an error, this event gets fired.

router:navigation:canceled

Another fairly obvious event. When a routing action is cancelled, such as inside of a custom pipeline step which checks if the user is logged in, this event gets fired.

router:navigation:success

Once a routing action has been completed, such as a user click a button and being navigated to a particular page and there are no errors, this event fires.

router:navigation:complete

Once everything is complete (not necessarily successful) this event fires. From what I can decipher, the complete event is similar to that of the processing event. The processing event is the first even to always fire before anything else and the complete event is the last event to fire. This event will always fire regardless of if there was an error or success within the routing process.

Using the Event Aggregator with Router events

If you are after a guide on how you can use the Event Aggregator, look no further than this post which describes how to subscribe to events.

 

Dwayne

 

6 thoughts on “Understanding Aurelia Router Events

  1. Disclaimer:
    Although its nice to know, its dangerous to build code upon knowlege about internals.
    (In fact its the worst kind of dependency, one can introduce into his/her code).

  2. Hi there,

    Thanks for the insightful article and the link to the Event Aggregator. For a noob to Aurelia like me they really helped me.

    Basically what I needed done was to be able to change the title tags for the current page as our site has some dynamic content on it. What I implemented works for the most part, however, when the url changes using this.router.navigateToRoute (on the same page) from something like /needs/volunteer to /needs/volunteer/all-provinces/all-cities/all-suburbs/all-categories/all-sub-categories, I would like to be able to subscribe to that event so that I can make changes to the title dependent upon the url params.

    I have thus far tried to subscribe to both “router:navigation:success” and “router:navigation:complete”, but either one only works on a complete page load and not when something triggers this.router.navigateToRoute on the same page.

    Kind regards
    Eben

  3. Thanks so much Dwayne! I struggled to find decent documentation on this at aurelia.io/docs, but your post described the solution I needed perfectly.
    Cheers mate.

  4. I’m running into the same issue as Eben. I need to act on an event when the user tries to navigate to a route on the same page which they are already on. The processing, complete and success events do not fire. Is there any way to determine when the user tries to navigate to a route of the same page they are on?

Leave a Reply

Your email address will not be published. Required fields are marked *