Old Guides - You are viewing the guides for Ember v3.28.0.
Go to v5.0.0

Redirecting

Edit pencil

Sometimes you want to redirect a user to a different page than what they requested for.

For example, if they're not logged in, you might want to prevent them from editing their profile, accessing private information, or checking out items in their shopping cart. Usually you want to redirect them to the login page, and after they have successfully logged in, take them back to the page they originally wanted to access.

There are many other reasons you probably want to have the last word on whether a user can or cannot access a certain page. Ember allows you to control that access with a combination of hooks and methods in your route.

One of the methods is transitionTo(). Calling transitionTo() from a route or transitionToRoute() from a controller will stop any transitions currently in progress and start a new one, functioning as a redirect. transitionTo() behaves exactly like the LinkTo helper.

The other one is replaceWith() which works the same way as transitionTo(). The only difference between them is how they manage history. replaceWith() substitutes the current route entry and replaces it with that of the route we are redirecting to, while transitionTo() leaves the entry for the current route and creates a new one for the redirection.

If the new route has dynamic segments, you need to pass either a model or an identifier for each segment. Passing a model will skip the route's model() hook since the model is already loaded.

Transitioning Before the Model is Known

Since a route's beforeModel() executes before the model() hook, it's a good place to do a redirect if you don't need any information that is contained in the model.

app/router.js
Router.map(function() {
  this.route('posts');
});
app/routes/index.js
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';

export default class IndexRoute extends Route {
  @service router;

  beforeModel(/* transition */) {
    this.router.transitionTo('posts'); // Implicitly aborts the on-going transition.
  }
}

beforeModel() receives the current transition as an argument, which we can store and retry later. This allows us to return the user back to the original route. For example, we might redirect a user to the login page when they try to edit their profile, and immediately redirect them back to the edit page once they have successfully logged in. See Storing and Retrying a Transition for how to do that.

If you need to examine some application state to figure out where to redirect, you might use a service.

Transitioning After the Model is Known

If you need information about the current model in order to decide about redirection, you can use the afterModel() hook. It receives the resolved model as the first parameter and the transition as the second one. For example:

app/router.js
Router.map(function() {
  this.route('posts');
  this.route('post', { path: '/post/:post_id' });
});
app/routes/posts.js
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';

export default class PostsRoute extends Route {
  @service router;

  afterModel(model, transition) {
    if (model.get('length') === 1) {
      this.router.transitionTo('post', model.get('firstObject'));
    }
  }
}

When transitioning to the posts route if it turns out that there is only one post, the current transition will be aborted in favor of redirecting to the PostRoute with the single post object being its model.

Zoey says...
If you attempt to redirect with the `queryParams` option, make sure that the query params are defined on the controller!

Child Routes

Let's change the router above to use a nested route, like this:

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

If we redirect to posts.post in the afterModel hook, afterModel essentially invalidates the current attempt to enter this route. So the posts route's beforeModel, model, and afterModel hooks will fire again within the new, redirected transition. This is inefficient, since they just fired before the redirect.

Instead, we can use the redirect() method, which will leave the original transition validated, and not cause the parent route's hooks to fire again:

app/routes/posts.js
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';

export default class PostsRoute extends Route {
  @service router;

  redirect(model, transition) {
    if (model.get('length') === 1) {
      this.router.transitionTo('posts.post', model.get('firstObject'));
    }
  }
}
On this page