Ember.Route Class packages/ember-routing/lib/system/route.js:43

This hook is executed when the router enters the route. It is not executed when the model for the route changes.

This hook is called after this route's model has resolved. It follows identical async/promise semantics to beforeModel but is provided the route's resolved model in addition to the transition, and is therefore suited to performing logic that can only take place after the model has already resolved.

1
2
3
4
5
6
7

App.PostsRoute = Ember.Route.extend({
  afterModel: function(posts, transition) {
    if (posts.get('length') === 1) {
      this.transitionTo('post.show', posts.get('firstObject'));
    }
  }
});

Refer to documentation for beforeModel for a description of transition-pausing semantics when a promise is returned from this hook.

This hook is the first of the route entry validation hooks called when an attempt is made to transition into a route or one of its children. It is called before model and afterModel, and is appropriate for cases when:

1) A decision can be made to redirect elsewhere without needing to resolve the model first. 2) Any async operations need to occur first before the model is attempted to be resolved.

This hook is provided the current transition attempt as a parameter, which can be used to .abort() the transition, save it for a later .retry(), or retrieve values set on it from a previous hook. You can also just call this.transitionTo to another route to implicitly abort the transition.

You can return a promise from this hook to pause the transition until the promise resolves (or rejects). This could be useful, for instance, for retrieving async code from the server that is required to enter a route.

1
2
3
4
5
6
7

App.PostRoute = Ember.Route.extend({
  beforeModel: function(transition) {
    if (!App.Post) {
      return Ember.$.getScript('/models/post.js');
    }
  }
});

If App.Post doesn't exist in the above example, beforeModel will use jQuery's getScript, which returns a promise that resolves after the server has successfully retrieved and executed the code from the server. Note that if an error were to occur, it would be passed to the error hook on Ember.Route, but it's also possible to handle errors specific to beforeModel right from within the hook (to distinguish from the shared error handling behavior of the error hook):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

App.PostRoute = Ember.Route.extend({
  beforeModel: function(transition) {
    if (!App.Post) {
      var self = this;
      return Ember.$.getScript('post.js').then(null, function(e) {
        self.transitionTo('help');

        // Note that the above transitionTo will implicitly
        // halt the transition. If you were to return
        // nothing from this promise reject handler,
        // according to promise semantics, that would
        // convert the reject into a resolve and the
        // transition would continue. To propagate the
        // error so that it'd be handled by the `error`
        // hook, you would have to
        return Ember.RSVP.reject(e);
      });
    }
  }
});

Returns the controller for a particular route or name.

The controller instance must already have been created, either through entering the associated route or using generateController.

1
2
3
4
5
6

App.PostRoute = Ember.Route.extend({
  setupController: function(controller, post) {
    this._super(controller, post);
    this.controllerFor('posts').set('currentPost', post);
  }
});

This hook is executed when the router completely exits this route. It is not executed when the model for the route changes.

Disconnects a view that has been rendered into an outlet.

You may pass any or all of the following options to disconnectOutlet:

• outlet: the name of the outlet to clear (default: 'main')
• parentView: the name of the view containing the outlet to clear (default: the view rendered by the parent route)

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

App.ApplicationRoute = App.Route.extend({
  actions: {
    showModal: function(evt) {
      this.render(evt.modalName, {
        outlet: 'modal',
        into: 'application'
      });
    },
    hideModal: function(evt) {
      this.disconnectOutlet({
        outlet: 'modal',
        parentView: 'application'
      });
    }
  }
});

Alternatively, you can pass the outlet name directly as a string.

Example:

1
2
3

hideModal: function(evt) {
  this.disconnectOutlet('modal');
}

Perform a synchronous transition into another route without attempting to resolve promises, update the URL, or abort any currently active asynchronous transitions (i.e. regular transitions caused by transitionTo or URL changes).

This method is handy for performing intermediate transitions on the way to a final destination route, and is called internally by the default implementations of the error and loading handlers.

A hook you can implement to convert the URL into the model for this route.

1
2
3

App.Router.map(function() {
  this.route('post', { path: '/posts/:post_id' });
});

The model for the post route is store.findRecord('post', params.post_id).

By default, if your route has a dynamic segment ending in _id:

• The model class is determined from the segment (post_id's class is App.Post)
• The find method is called on the model class with the value of the dynamic segment.

Note that for routes with dynamic segments, this hook is not always executed. If the route is entered through a transition (e.g. when using the link-to Handlebars helper or the transitionTo method of routes), and a model context is already provided this hook is not called.

A model context does not include a primitive string or number, which does cause the model hook to be called.

Routes without dynamic segments will always execute the model hook.

1
2
3
4
5
6
7
8
9
10
11
12
13
14

// no dynamic segment, model hook always called
this.transitionTo('posts');

// model passed in, so model hook not called
thePost = store.findRecord('post', 1);
this.transitionTo('post', thePost);

// integer passed in, model hook is called
this.transitionTo('post', 1);

// model id passed in, model hook is called
// useful for forcing the hook to execute
thePost = store.findRecord('post', 1);
this.transitionTo('post', thePost.id);

This hook follows the asynchronous/promise semantics described in the documentation for beforeModel. In particular, if a promise returned from model fails, the error will be handled by the error hook on Ember.Route.

Example

1
2
3
4
5

App.PostRoute = Ember.Route.extend({
  model: function(params) {
    return this.store.findRecord('post', params.post_id);
  }
});

Returns the resolved model of a parent (or any ancestor) route in a route hierarchy. During a transition, all routes must resolve a model object, and if a route needs access to a parent route's model in order to resolve a model (or just reuse the model from a parent), it can call this.modelFor(theNameOfParentRoute) to retrieve it. If the ancestor route's model was a promise, its resolved result is returned.

Example

1
2
3
4
5
6
7
8
9
10
11

App.Router.map(function() {
    this.route('post', { path: '/post/:post_id' }, function() {
      this.route('comments', { resetNamespace: true });
    });
});

App.CommentsRoute = Ember.Route.extend({
    afterModel: function() {
      this.set('post', this.modelFor('post'));
    }
});

Retrieves parameters, for current route using the state.params variable and getQueryParamsFor, using the supplied routeName.

A hook you can implement to optionally redirect to another route.

If you call this.transitionTo from inside of this hook, this route will not be entered in favor of the other hook.

redirect and afterModel behave very similarly and are called almost at the same time, but they have an important distinction in the case that, from one of these hooks, a redirect into a child route of this route occurs: redirects from afterModel essentially invalidate the current attempt to enter this route, and will result in this route's beforeModel, model, and afterModel hooks being fired again within the new, redirecting transition. Redirects that occur within the redirect hook, on the other hand, will not cause these hooks to be fired again the second time around; in other words, by the time the redirect hook has been called, both the resolved model and attempted entry into this route are considered to be fully validated.

Refresh the model on this route and any child routes, firing the beforeModel, model, and afterModel hooks in a similar fashion to how routes are entered when transitioning in from other route. The current route params (e.g. article_id) will be passed in to the respective model hooks, and if a different model is returned, setupController and associated route hooks will re-fire as well.

An example usage of this method is re-querying the server for the latest information using the same parameters as when the route was first entered.

Note that this will cause model hooks to fire even on routes that were provided a model object when the route was initially entered.

render is used to render a template into a region of another template (indicated by an {{outlet}}). render is used both during the entry phase of routing (via the renderTemplate hook) and later in response to user interaction.

For example, given the following minimal router and templates:

1
2
3

Router.map(function() {
  this.route('photos');
});

1
2
3
4

<!-- application.hbs -->
<div class='something-in-the-app-hbs'>
  {{outlet "anOutletName"}}
</div>

1
2

<!-- photos.hbs -->
<h1>Photos</h1>

You can render photos.hbs into the "anOutletName" outlet of application.hbs by calling render:

1
2
3
4
5
6
7
8
9

// posts route
Ember.Route.extend({
  renderTemplate: function() {
    this.render('photos', {
      into: 'application',
      outlet: 'anOutletName'
    })
  }
});

render additionally allows you to supply which view, controller, and model objects should be loaded and associated with the rendered template.

1
2
3
4
5
6
7
8
9
10
11
12

// posts route
Ember.Route.extend({
  renderTemplate: function(controller, model){
    this.render('posts', {    // the template to render, referenced by name
      into: 'application',    // the template to render into, referenced by name
      outlet: 'anOutletName', // the outlet inside `options.template` to render into.
      view: 'aViewName',      // the view to use for this template, referenced by name
      controller: 'someControllerName', // the controller to use for this template, referenced by name
      model: model            // the model to set on `options.controller`.
    })
  }
});

The string values provided for the template name, view, and controller will eventually pass through to the resolver for lookup. See Ember.Resolver for how these are mapped to JavaScript objects in your application.

Not all options need to be passed to render. Default values will be used based on the name of the route specified in the router or the Route's controllerName, viewName and templateName properties.

For example:

1
2
3
4
5

// router
Router.map(function() {
  this.route('index');
  this.route('post', { path: '/posts/:post_id' });
});

1
2
3
4
5
6

// post route
PostRoute = App.Route.extend({
  renderTemplate: function() {
    this.render(); // all defaults apply
  }
});

The name of the PostRoute, defined by the router, is post.

The following equivalent default options will be applied when the Route calls render:

1
2
3
4
5
6
7

//
this.render('post', {  // the template name associated with 'post' Route
  into: 'application', // the parent route to 'post' Route
  outlet: 'main',      // {{outlet}} and {{outlet 'main'}} are synonymous,
  view: 'post',        // the view associated with the 'post' Route
  controller: 'post',  // the controller associated with the 'post' Route
})

By default the controller's model will be the route's model, so it does not need to be passed unless you wish to change which model is being used.

A hook you can use to render the template for the current route.

This method is called with the controller for the current route and the model supplied by the model hook. By default, it renders the route's template, configured with the controller for the route.

This method can be overridden to set up and render additional or alternative templates.

1
2
3
4
5
6
7
8
9
10
11
12
13

App.PostsRoute = Ember.Route.extend({
  renderTemplate: function(controller, model) {
    var favController = this.controllerFor('favoritePost');

    // Render the `favoritePost` template into
    // the outlet `posts`, and display the `favoritePost`
    // controller.
    this.render('favoritePost', {
      outlet: 'posts',
      controller: favController
    });
  }
});

Transition into another route while replacing the current URL, if possible. This will replace the current history entry instead of adding a new one. Beside that, it is identical to transitionTo in all other respects. See 'transitionTo' for additional information regarding multiple models.

Example

1
2
3
4
5
6
7
8
9
10
11
12

App.Router.map(function() {
  this.route('index');
  this.route('secret');
});

App.SecretRoute = Ember.Route.extend({
  afterModel: function() {
    if (!authorized()){
      this.replaceWith('index');
    }
  }
});

A hook you can use to reset controller values either when the model changes or the route is exiting.

1
2
3
4
5
6
7
8
9

App.ArticlesRoute = Ember.Route.extend({
  // ...

  resetController: function(controller, isExiting, transition) {
    if (isExiting) {
      controller.set('page', 1);
    }
  }
});

Sends an action to the router, which will delegate it to the currently active route hierarchy per the bubbling rules explained under actions.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

App.Router.map(function() {
  this.route('index');
});

App.ApplicationRoute = Ember.Route.extend({
  actions: {
    track: function(arg) {
      console.log(arg, 'was clicked');
    }
  }
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    trackIfDebug: function(arg) {
      if (debug) {
        this.send('track', arg);
      }
    }
  }
});

A hook you can implement to convert the route's model into parameters for the URL.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

App.Router.map(function() {
  this.route('post', { path: '/posts/:post_id' });
});

App.PostRoute = Ember.Route.extend({
  model: function(params) {
    // the server returns `{ id: 12 }`
    return Ember.$.getJSON('/posts/' + params.post_id);
  },

  serialize: function(model) {
    // this will make the URL `/posts/12`
    return { post_id: model.id };
  }
});

The default serialize method will insert the model's id into the route's dynamic segment (in this case, :post_id) if the segment contains 'id'. If the route has multiple dynamic segments or does not contain 'id', serialize will return Ember.getProperties(model, params)

This method is called when transitionTo is called with a context in order to populate the URL.

A hook you can use to setup the controller for the current route.

This method is called with the controller for the current route and the model supplied by the model hook.

By default, the setupController hook sets the model property of the controller to the model.

If you implement the setupController hook in your Route, it will prevent this default behavior. If you want to preserve that behavior when implementing your setupController function, make sure to call _super:

1
2
3
4
5
6
7
8
9
10
11
12

App.PhotosRoute = Ember.Route.extend({
  model: function() {
    return this.store.findAll('photo');
  },

  setupController: function(controller, model) {
    // Call _super for default behavior
    this._super(controller, model);
    // Implement your custom setup after
    this.controllerFor('application').set('showingPhotos', true);
  }
});

The provided controller will be one resolved based on the name of this route.

If no explicit controller is defined, Ember will automatically create one.

As an example, consider the router:

1
2
3

App.Router.map(function() {
  this.route('post', { path: '/posts/:post_id' });
});

For the post route, a controller named App.PostController would be used if it is defined. If it is not defined, a basic Ember.Controller instance would be used.

Example

1
2
3
4
5

App.PostRoute = Ember.Route.extend({
  setupController: function(controller, model) {
    controller.set('model', model);
  }
});

Transition the application into another route. The route may be either a single route or route path:

1
2

this.transitionTo('blogPosts');
this.transitionTo('blogPosts.recentEntries');

Optionally supply a model for the route in question. The model will be serialized into the URL using the serialize hook of the route:

1

this.transitionTo('blogPost', aPost);

If a literal is passed (such as a number or a string), it will be treated as an identifier instead. In this case, the model hook of the route will be triggered:

1

this.transitionTo('blogPost', 1);

Multiple models will be applied last to first recursively up the route tree.

1
2
3
4
5
6
7
8

App.Router.map(function() {
  this.route('blogPost', { path:':blogPostId' }, function() {
    this.route('blogComment', { path: ':blogCommentId', resetNamespace: true });
  });
});

this.transitionTo('blogComment', aPost, aComment);
this.transitionTo('blogComment', 1, 13);

It is also possible to pass a URL (a string that starts with a /). This is intended for testing and debugging purposes and should rarely be used in production code.

1
2
3

this.transitionTo('/');
this.transitionTo('/blog/post/1/comment/13');
this.transitionTo('/blog/posts?sort=title');

An options hash with a queryParams property may be provided as the final argument to add query parameters to the destination URL.

1
2
3
4
5
6

this.transitionTo('blogPost', 1, {
  queryParams: {showComments: 'true'}
});

// if you just want to transition the query parameters without changing the route
this.transitionTo({queryParams: {sort: 'date'}});

See also replaceWith.

Simple Transition Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

App.Router.map(function() {
  this.route('index');
  this.route('secret');
  this.route('fourOhFour', { path: '*:' });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    moveToSecret: function(context) {
      if (authorized()) {
        this.transitionTo('secret', context);
      } else {
        this.transitionTo('fourOhFour');
      }
    }
  }
});

Transition to a nested route

1
2
3
4
5
6
7
8
9
10
11
12
13

App.Router.map(function() {
  this.route('articles', { path: '/articles' }, function() {
    this.route('new');
  });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    transitionToNewArticle: function() {
      this.transitionTo('articles.new');
    }
  }
});

Multiple Models Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

App.Router.map(function() {
  this.route('index');

  this.route('breakfast', { path: ':breakfastId' }, function() {
    this.route('cereal', { path: ':cerealId', resetNamespace: true });
  });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    moveToChocolateCereal: function() {
      var cereal = { cerealId: 'ChocolateYumminess' };
      var breakfast = { breakfastId: 'CerealAndMilk' };

      this.transitionTo('cereal', breakfast, cereal);
    }
  }
});

Nested Route with Query String Example

1
2
3
4
5
6
7
8
9
10
11
12
13

App.Router.map(function() {
  this.route('fruits', function() {
    this.route('apples');
  });
});

App.IndexRoute = Ember.Route.extend({
  actions: {
    transitionToApples: function() {
      this.transitionTo('fruits.apples', {queryParams: {color: 'red'}});
    }
  }
});