Old Guides - You are viewing the guides for Ember v2.4.0. VIEW v3.6.0
Edit Page

Links


You create a link to a route using the {{link-to}} helper.

Router.map(function() {
  this.route('photos', function(){
    this.route('edit', { path: '/:photo_id' });
  });
});
<ul>
  {{#each photos as |photo|}}
    <li>{{#link-to "photos.edit" photo}}{{photo.title}}{{/link-to}}</li>
  {{/each}}
</ul>

If the model for the photos template is a list of three photos, the rendered HTML would look something like this:

<ul>
  <li><a href="/photos/1">Happy Kittens</a></li>
  <li><a href="/photos/2">Puppy Running</a></li>
  <li><a href="/photos/3">Mountain Landscape</a></li>
</ul>

The {{link-to}} helper takes one or two arguments:

  • The name of a route. In this example, it would be index, photos, or photos.edit.
  • At most one model for each dynamic segment. By default, Ember.js will replace each segment with the value of the corresponding object's id property. In the example above, the second argument is each photo object, and the id property is used to fill in the dynamic segment with either 1, 2, or 3. If there is no model to pass to the helper, you can provide an explicit value instead:
{{#link-to "photos.edit" 1}}
  First Photo Ever
{{/link-to}}

When the rendered link matches the current route, and the same object instance is passed into the helper, then the link is given class="active". For example, if you were at the URL /photos/2, the first example above would render as:

<ul>
  <li><a href="/photos/1">Happy Kittens</a></li>
  <li><a href="/photos/2" class="active">Puppy Running</a></li>
  <li><a href="/photos/3">Mountain Landscape</a></li>
</ul>

Example for Multiple Segments

If the route is nested, you can supply a model or an identifier for each dynamic segment.

Router.map(function() {
  this.route('photos', function(){
    this.route('photo', { path: '/:photo_id' }, function(){
      this.route('comments');
      this.route('comment', { path: '/comments/:comment_id' });
    });
  });
});
<div class="photo">
  {{body}}
</div>

<p>{{#link-to "photos.photo.comment" primaryComment}}Main Comment{{/link-to}}</p>

If you specify only one model, it will represent the innermost dynamic segment :comment_id. The :photo_id segment will use the current photo.

Alternatively, you could pass both a photo's ID and a comment to the helper:

<p>
  {{#link-to 'photo.comment' 5 primaryComment}}
    Main Comment for the Next Photo
  {{/link-to}}
</p>

In the above example, the model hook for PhotoRoute will run with params.photo_id = 5. The model hook for CommentRoute won't run since you supplied a model object for the comment segment. The comment's id will populate the url according to CommentRoute's serialize hook.

Setting query-params

The query-params helper can be used to set query params on a link:

// Explicitly set target query params
{{#link-to "posts" (query-params direction="asc")}}Sort{{/link-to}}

// Binding is also supported
{{#link-to "posts" (query-params direction=otherDirection)}}Sort{{/link-to}}

For more information on how to use query parameters see the query parameters section in Routing.

In addition to being used as a block expression, the link-to helper can also be used in inline form by specifying the link text as the first argument to the helper:

A link in {{#link-to "index"}}Block Expression Form{{/link-to}},
and a link in {{link-to "Inline Form" "index"}}.

The output of the above would be:

A link in <a href="/">Block Expression Form</a>,
and a link in <a href="/">Inline Form</a>.

When generating a link you might want to set additional attributes for it. You can do this with additional arguments to the link-to helper:

<p>
  {{link-to "Edit this photo" "photo.edit" photo class="btn btn-primary"}}
</p>

Many of the common HTML properties you would want to use like class, and rel will work. When adding class names, Ember will also apply the standard ember-view and possibly active class names.

Replacing history entries

The default behavior for link-to is to add entries to the browser's history when transitioning between the routes. However, to replace the current entry in the browser's history you can use the replace=true option:

<p>
  {{#link-to "photo.comment" 5 primaryComment replace=true}}
    Main Comment for the Next Photo
  {{/link-to}}
</p>